-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,56 @@ | ||
# imgr | ||
|
||
An image to ascii converter written in rust | ||
A rust-powered image-to-ascii converter | ||
|
||
# Usage | ||
**Usage:** | ||
|
||
``` | ||
```bash | ||
imgr [options] <path to image> | ||
``` | ||
|
||
# Options | ||
|
||
|
||
## Color | ||
**Options:** | ||
|
||
To enable colored output | ||
**Color:** | ||
|
||
`-c` or `--colored` | ||
- Enable colored output: | ||
- `-c` or `--colored` | ||
|
||
## Styles | ||
**Styles:** | ||
|
||
To set the style of image | ||
|
||
`-s <style>` or `--style <style>` | ||
- Set the style of the image: | ||
- `-s <style>` or `--style <style>` | ||
|
||
Available options: | ||
- ascii (default) | ||
- block | ||
- braille (experimental) | ||
|
||
## Resize | ||
- ascii (default) | ||
- block | ||
- braille (experimental) | ||
|
||
To enable image resizing | ||
**Resize:** | ||
|
||
`-r` or `--resize` | ||
- Enable image resizing: | ||
- `-r` or `--resize` | ||
|
||
**also set the resizing scale using:** | ||
- Set the resizing scale: | ||
- `-S` or `--scale` | ||
|
||
`-S` or `--scale` | ||
Default scale: `2` | ||
|
||
default set to: `2` | ||
## Installation | ||
|
||
**Using Cargo:** | ||
|
||
# Installation | ||
|
||
### Cargo | ||
|
||
``` | ||
```bash | ||
cargo install imgr | ||
``` | ||
|
||
### From source | ||
**From Source:** | ||
|
||
``` | ||
```bash | ||
git clone https://github.com/shamxl/imgr.git | ||
cd imgr | ||
cargo build --release --path . | ||
``` | ||
|
||
<br> | ||
**Note:** | ||
|
||
> [!NOTE] | ||
> As I continue my journey with Rust, please pardon any imperfections in this program – they're all part of the learning process. | ||
As I continue my journey with Rust, please pardon any imperfections in this program. They're all part of the learning process. |