# image-sorter

![Continuous Integration](https://github.com/jgalat/image-sorter/workflows/Continuous%20Integration/badge.svg)
[![Crate Status](https://img.shields.io/crates/v/image-sorter.svg)](https://crates.io/crates/image-sorter)

![Demo](.github/screenshot.jpg)

A terminal user interface for sorting images. It requires w3m to render the images.

## Installation

The binary executable is `image-sorter`.

### Cargo

Install with

```bash
cargo install image-sorter
```

To update, run

```bash
cargo install image-sorter --force
```

### Release

Find the latest release [here](https://github.com/jgalat/image-sorter/releases).

### Repository

Requires `cargo` to be installed.

Clone or download this repository and run the following inside the project

```bash
cargo install --path .
```

## Usage

Once installed, run the following to print the help message

```bash
image-sorter --help
```

Here is an example usage

```bash 
image-sorter -b w=~/4/wg g=~/4/g -o run.sh -- image.jpg ~/Downloads/
```

Running the command above will configure the program like this
- bind `w` to the path `~/4/wg`
- bind `g` to the path `~/4/g`
- set `run.sh` as the output script of the program
- the software will list `image.jpg` and all the images inside `~/Downloads/` so they can be sorted