diff --git a/README.md b/README.md index 3c148fc..fb2ea1f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@ ascii-image-converter is a command-line tool that converts images into ascii art Currently, the tool supports PNG, JPEG/JPG, WEBP and BMP image formats +
+### Example ([source](https://miro.medium.com/max/3200/0*hd2Ib9nYpedgSDsf)): +![Example1](https://raw.githubusercontent.com/TheZoraiz/ascii-image-converter/master/example_images/tree.png) +### ASCII art: +![Example2](https://raw.githubusercontent.com/TheZoraiz/ascii-image-converter/master/example_images/ascii_tree.png) + +
## Installation First download the executables from [here](https://github.com/TheZoraiz/ascii-image-converter/releases/tag/v1.1.1), and follow the steps with respect to your OS. @@ -26,6 +33,7 @@ Extract Executables.zip and open the "Windows" folder. Copy the path to folder f * In the Edit Environment Variable window, click "New" and then paste the path of the folder that you copied initially. * Afterwards, you can use it anywhere by typing "ascii-image-converter" in command prompt. Note: Make sure you restart the command prompt. +
## Usage To convert an image into ascii format, the usage is as follows: ``` @@ -35,7 +43,7 @@ Example ``` ascii-image-converter myImage.jpeg ``` - +
### Flags #### --complex OR -c @@ -65,16 +73,17 @@ ascii-image-converter [path to image] --save ascii-image-converter [path to image] -S ``` - +
You can combine commands as well ``` ascii-image-converter [path to image] -Scd 100,30 ``` - +
## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + ## License [Apache-2.0](https://github.com/TheZoraiz/ascii-image-converter/blob/master/LICENSE) \ No newline at end of file