AlexGustafsson / qoi

Qoi is a simple tool for working with QOI (an image format). It's cross-platform and written in Rust.

Quick Start | Contribute

Qoi

A cross-platform CLI tool for viewing QOI files

Qoi is a simple tool for working with the QOI image format. It's cross-platform and written in Rust.

Quickstart

First, download the latest release for your architecture.

The tool can then be used to view a file like so:

qoi view image.qoi

Table of contents

Quickstart
Features
Installation
Usage
Metrics
Contributing

Features

• Supports QOI according to the specification version 1.0, 2022.01.05
• Cross-platform image viewer

Installation

Downloading a pre-built release

Download the latest release from here.

Build from source

Clone the repository.

git clone https://github.com/AlexGustafsson/qoi.git && cd qoi

Optionally check out a specific version.

git checkout v0.1.0

Build the project.

cargo build --release

Usage

A Quite OK Image Format viewer

USAGE:
    tool <SUBCOMMAND>

OPTIONS:
    -h, --help    Print help information

SUBCOMMANDS:
    help    Print this message or the help of the given subcommand(s)
    info    Display information about the image
    view    View an image

Example:

qoi view qoi.qoi
qoi info qoi.qoi

Contributing

Any help with the project is more than welcome. Note though that this project is mostly meant for learning Rust. It's not intended to grow into some fully-fledged toolset.

Development

# Clone the repository
https://github.com/AlexGustafsson/qoi.git && cd qoi

# Build for the native platform
cargo build

# Produce release builds for all platforms
cargo build

You might need to install toolchains for cross-compiling.

rustup target add x86_64-unknown-linux-musl
rustup target add x86_64-unknown-darwin-musl
rustup target add x86_64-apple-darwin