Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
taga3s committed Aug 18, 2024
1 parent 1066bc7 commit f9f0454
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ A CLI tool for generating ASCII Art from any image you like.

## Usage

Here is basic command. We support `.jpg (jpeg)` and `.png` image.
Here is basic command. It supports `.jpg (.jpeg)` and `.png` image.

```
$ ascii-art-gen ./cat.png
```

You can use `--threshold` or `-t` option to use any threshold. The default threshold is 128.
You can use `--threshold` or `-t` option to use any threshold. The default threshold is determined automatically by [OTSU's method](https://en.wikipedia.org/wiki/Otsu%27s_method).

```
$ ascii-art-gen -t 110 ./cat.png
$ ascii-art-gen -t 128 ./cat.png
```

You can use `--magnification` or `-m` option to control the size of the ascii art. The default magnification is 1.0.
Expand All @@ -31,6 +31,11 @@ $ ascii-art-gen -m 2.0 ./cat.png
$ go run main.go <image>
```

- format
```
$ make fmt
```

- test
```
$ make test
Expand Down

0 comments on commit f9f0454

Please sign in to comment.