Skip to content

Commit

Permalink
Merge pull request #10 from seujorgenochurras/documentation
Browse files Browse the repository at this point in the history
Add Results in README.md
  • Loading branch information
seujorgenochurras authored Feb 13, 2024
2 parents dfeee89 + ecf1226 commit da710fd
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,22 @@
image-to-ascii is a java image to ascii art parser, as the name implies, it generates an ASCII art from any image.<br>
It is highly configurable but at the same time easy to use.


## Results

<div>

<img src="src/main/resources/image/demo/car-colorful.png" alt="car" width="450px"/>

<img src="src/main/resources/image/demo/neofetch.png" alt="neofetch" width="550px"/>

<img src="src/main/resources/image/demo/lion-no-color.png" alt="lion" width="350px"/>

<img src="src/main/resources/image/demo/holow-knight-big.png" alt="hollow" width="650px"/>
</div>
<br>

# Download
I haven't tested it yet, but I'm 99% sure you need to be using any jdk above 18<br>
Gradle:

```gradle
Expand Down Expand Up @@ -52,6 +66,7 @@ So if you are in a hurry or you just don't want to read the code you can use the
fileWriter.flush();

```
<br>

## Configurations

Expand All @@ -71,7 +86,7 @@ If you want to configure more stuff such as the core algorithms, you can do it w
.withColor(new AnsiColorAlgorithm())
.build();

String asciiArt = AsciiParser.parse(imagePath, parserConfig);
String asciiArt = AsciiParser.parse(imagePath, parserConfig);

```

Expand Down
Binary file added src/main/resources/image/car.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/image/demo/car-colorful.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/image/demo/lion-no-color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/image/demo/neofetch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/image/hollow-knight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/image/lion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit da710fd

Please sign in to comment.