1- # Convert2ASCII
1+ # Convert2Ascii
22
33Convert Image/Video to ASCII art.
44
55
6+ ## Intro
7+
8+ convert2ascii provides two executable commands:
9+
10+ * image2ascii: transform picture to ascii art and display in terminal.
11+ * video2ascii: transform video to ascii art, you can save or play it in terminal.
12+
13+ It also provides classes as a gem:
14+
15+ * Convert2Ascii::Image2Ascii
16+ * Convert2Ascii::Video2Ascii
17+
18+ you can use it in your code and make your own ascii art !
19+
20+
621## Test pass
722
823* MacOS 15.2 ✅
@@ -20,57 +35,57 @@ Convert Image/Video to ASCII art.
2035
2136## Prerequisites
2237
23- * Ruby3 +
38+ * Ruby 3 +
2439* ImageMagick ([ Download here] ( https://imagemagick.org/script/download.php ) )
2540* ffmpeg ([ Download here] ( https://www.ffmpeg.org/ ) )
2641
2742# How to use
2843
29- ## Try in docker
44+ ## Try in Docker
3045
3146` $ docker run -it -v $(pwd):/app mark24code/convert2ascii bash -c "cd /app && exec bash" `
3247
33- > ` $(pwd) ` can change to your local path, here use you working path.
48+ > ` $(pwd) ` can be changed to your local path. Here, use your working path.
3449
3550
3651## Install
3752
38- ` gem install convert2ascii `
53+ ` $ gem install convert2ascii`
3954
4055
41- ## Executable command
56+ ## Executable commands
4257
4358### image2ascii
4459
45- Make image to ascii art in your terminal .
60+ Convert an image to ascii art.
4661
4762``` bash
4863image2ascii -h
4964Usage: image2ascii [options]
50- --version verison
65+ --version version
5166 -i, --image=URI image uri (required)
5267 -w, --width=WIDTH image width (integer)
53- -s, --style=STYLE ascii style: [ ' color' | ' text' ]
54- -b, --block ascii color style use BLOCK or not [ true | false ]
68+ -s, --style=STYLE ascii style: ' color' / ' text'
69+ -b, --block ascii color style use BLOCK or not true/ false
5570```
5671
5772### video2ascii
5873
59- Make image to ascii art in your terminal .
74+ Convert a video to ascii art.
6075
6176``` bash
6277Usage: video2ascii [options]
6378
64- * default will generate and play without save .
65- * -p will just play ascii frames dir , and ignore -i, -o others options. --loop will play loop
79+ * By default, it will generate and play without saving .
80+ * The -p option will just play the ascii frames within the directory , and ignore -i, -o other options. --loop will play loop
6681* -i,-o will just generate and output frames and ignore others options
67- --version verison
82+ --version version
6883 -i, --input=URI video uri (required)
6984 -w, --width=WIDTH video width (integer)
7085 -s, --style=STYLE ascii style: [' color' | ' text' ]
7186 -b, --block ascii color style use BLOCK or not [ true | false ]
72- -o, --ouput=OUTPUT save ascii frame to output dirname
73- -p, --play_dir=PLAY_DIRNAME input ascii frames dirname to play
87+ -o, --ouput=OUTPUT save ascii frames to the output directory
88+ -p, --play_dir=PLAY_DIRNAME input the ascii frames directory to play
7489 --loop
7590```
7691
0 commit comments