# Installation
## Linux
Just download the appropriate binary from [latest release](https://github.com/ndr3www/rustii/releases/latest) and copy it to a directory specified in your `$PATH`, for example:
`sudo cp rustii /usr/bin`
## Windows
1. Download **rustii.exe** from [latest release](https://github.com/ndr3www/rustii/releases/latest)
2. Create a folder named **rustii** anywhere you like
3. Copy **rustii.exe** to the newly created folder
4. Type `environment` in your search bar and hit `Enter`
5. Click the `Environment Variables...` button
6. Select **Path** variable and click `Edit...`
7. Click `New` and then `Browse...`, then find and select the **rustii** folder
8. Click `OK` and you're done!
# Usage
Basically `rustii` has 2 commands:
- `render` - generates ASCII art from a specified image
- `open` - prints specified ASCII art to the terminal/console
`rustii` compresses generated ASCII art file by default, so if you want to get the raw ASCII art, you can simply redirect the output of the `open` command, for example: `rustii open ascii.txt > raw_ascii.txt`
Type `rustii --help` or `rustii -h` to get more details
# Examples
`rustii render avatar.jpg --output ascii.txt --scale 0.22 0.09 --contrast 10`
`rustii render catedral.jpg --output ascii.txt --scale 0.13 0.053`
`rustii render woman.jpg --output ascii.txt --scale 0.09 0.032 --contrast -5`
