Skip to content

Commit 7e115be

Browse files
update: added installation guide
1 parent f876589 commit 7e115be

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,21 @@
11
# go-img2ascii - An image-to-ascii converter
22
This is a cli tool that converts any jpeg, jpg or png image to an ascii representation.
33

4-
## Usage
5-
```go run main.go [path-to-image] [character-width]```
6-
74
## Sample
85
|Original|Ascii'd|
96
|-|-|
107
| ![image](https://github.com/codelikesuraj/go-img2ascii/assets/70463535/32a519a6-fd2d-4c0c-ba29-6f16430a7713) | ![image](https://github.com/codelikesuraj/go-img2ascii/assets/70463535/e9da71eb-97c6-4942-9419-4f33a67887db) |
118
| ![image](https://github.com/codelikesuraj/go-img2ascii/assets/70463535/1e4f629b-f69b-48b4-a1a4-7dd1a857f377) | ![image](https://github.com/codelikesuraj/go-img2ascii/assets/70463535/55f79285-91b8-47ed-af4f-79247abf98ec) |
129

10+
## Usage
11+
```go run main.go [path-to-image] [character-width]```
12+
13+
## Installation
14+
- [Click here to download the latest release for your platform](https://github.com/codelikesuraj/go-img2ascii/releases).
15+
- Extract the archive to a preferred folder/directory
16+
- Ensure this folder/directory is in your OS' PATH, otherwise add it to PATH
17+
- Now you can run ```go-img2ascii [path-to-image] [character-width]``` from anywhere
18+
1319
## Todo
1420
- ✅ load and decode image file
1521
- ✅ resize the image

0 commit comments

Comments
 (0)