convert2ascii 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37a56a08059d638a7c1e406248484e8fb3ca0fd1d494c8676ac5cc1119e15eeb
-  data.tar.gz: 3cbf2abb2d13a8a1d1091128852584d35d073ac8b1d7a056dc856916d913582d
+  metadata.gz: 7ba7bbea3873db90bd7d9d7806f9861bd409489789b85d2a6598fd117fb7f7d2
+  data.tar.gz: e2e931cac272e36341bfbd6554634dfcc25401a58e7c6f2c8bc79c5b9127a8f9
 SHA512:
-  metadata.gz: e1dcecc188abc4c1a5916199f91fba45fa1ee70d6fe25427a27b502e5c41fa57fe3c3dedf4cd0a7f3402ac36f132e44f87874ada185d0dc374d78eb29fd9e389
-  data.tar.gz: aedcc98597e9ef05af5c26435384cb72741b2e97cca92df0e1e2b44e9314f0f2a465f5a070503db29a5bc16bb0cc97933ab4ab7a9b9d21f44179f9df923bc6f9
+  metadata.gz: eeaf96c3b3e0699785dc0706ccffed9acea4fcf6500d53862a98509d1047416621db0d27100d59f9c7b00fa94dac6a5e99dd71cdd48f5f183830152b06a5380c
+  data.tar.gz: f952e61a0e3c47d97390edef85f4400e3467761186cac528ba4e349a4931caae4b5c5d3284062fe871f761a2cef41903e377ea84d8f3aababfcd97ad6e74728e

data/README.md

@@ -1,8 +1,23 @@
-# Convert2ASCII
+# Convert2Ascii
 
 Convert Image/Video to ASCII art.
 
 
+## Intro
+
+convert2ascii provides two executable commands：
+
+* image2ascii: transform picture to ascii art and display in terminal.
+* video2ascii: transform video to ascii art, you can save or play it in terminal.
+
+It also provides classes as a gem:
+
+* Convert2Ascii::Image2Ascii
+* Convert2Ascii::Video2Ascii
+
+you can use it in your code and make your own ascii art !
+
+
 ## Test pass
 
 * MacOS 15.2 ✅
@@ -20,44 +35,57 @@ Convert Image/Video to ASCII art.
 
 ## Prerequisites
 
-* Ruby3+
+* Ruby 3+
 * ImageMagick ([Download here](https://imagemagick.org/script/download.php))
 * ffmpeg ([Download here](https://www.ffmpeg.org/))
 
+# How to use
+
+## Try in Docker
+
+`$ docker run -it -v $(pwd):/app  mark24code/convert2ascii bash -c "cd /app && exec bash"`
 
-## Executable command
+>  `$(pwd)` can be changed to your local path. Here, use your working path.
+
+
+## Install
+
+`$ gem install convert2ascii`
+
+
+## Executable commands
 
 ### image2ascii
 
-Make image to ascii art in your terminal.
+Convert an image to ascii art.
 
 ```bash
 image2ascii -h
 Usage: image2ascii [options]
-        --version                    verison
+        --version                    version
     -i, --image=URI                  image uri (required)
     -w, --width=WIDTH                image width (integer)
-    -s, --style=STYLE                ascii style: ['color'| 'text']
-    -b, --block                      ascii color style use BLOCK or not [ true | false ]
+    -s, --style=STYLE                ascii style: 'color'/'text'
+    -b, --block                      ascii color style use BLOCK or not true/false
 ```
 
 ### video2ascii
 
-Make image to ascii art in your terminal.
+Convert a video to ascii art.
 
 ```bash
 Usage: video2ascii [options]
 
-* default will generate and play without save.
-* -p will just play ascii frames dir, and ignore -i, -o others options. --loop will play loop
+* By default, it will generate and play without saving.
+* The -p option will just play the ascii frames within the directory, and ignore -i, -o other options. --loop will play loop
 * -i,-o will just generate and output frames and ignore others options
-        --version                    verison
+        --version                    version
     -i, --input=URI                  video uri (required)
     -w, --width=WIDTH                video width (integer)
     -s, --style=STYLE                ascii style: ['color'| 'text']
     -b, --block                      ascii color style use BLOCK or not [ true | false ]
-    -o, --ouput=OUTPUT               save ascii frame to output dirname
-    -p, --play_dir=PLAY_DIRNAME      input ascii frames dirname to play
+    -o, --ouput=OUTPUT               save ascii frames to the output directory
+    -p, --play_dir=PLAY_DIRNAME      input the ascii frames directory to play
         --loop
 ```
 
@@ -108,6 +136,7 @@ ascii.generate.play
 
 ```
 
+
 ## Inspired by
 
 * [michaelkofron/image2ascii](https://github.com/michaelkofron/image2ascii)

data/Rakefile

@@ -14,6 +14,19 @@ task :build_rdoc do
   system("rdoc build")
 end
 
+desc "Build Docker image"
+task :build_docker do
+  system("docker build . -t mark24code/convert2ascii:latest")
+end
+
+desc "Push Docker image"
+task :push_docker do
+  system("docker push mark24code/convert2ascii:latest")
+end
 
+desc "Run in docker"
+task :run_in_docker do
+  system("docker run -it -v $(pwd):/app  mark24code/convert2ascii bash -c \"cd /app && exec bash\"")
+end
 
 task default: %i[]

data/exe/image2ascii

@@ -7,7 +7,7 @@ options = {}
 OptionParser.new do |parser|
   parser.banner = "Usage: image2ascii [options]"
 
-  parser.on("--version", "verison") do |v|
+  parser.on("--version", "version") do |v|
     puts "convert2ascii/image2ascii: v#{::Convert2Ascii::VERSION}"
     puts "author: Mark24"
     puts "mail: mark.zhangyoung@gmail.com"

data/exe/video2ascii

@@ -45,7 +45,7 @@ Usage: video2ascii [options]
 * -p will just play ascii frames dir, and ignore -i, -o others options. --loop will play loop
 * -i,-o will just generate and output frames and ignore others options
 DOC
-  parser.on("--version", "verison") do |v|
+  parser.on("--version", "version") do |v|
     puts "convert2ascii/video2ascii: v#{::Convert2Ascii::VERSION}"
     puts "author: Mark24"
     puts "mail: mark.zhangyoung@gmail.com"
@@ -82,11 +82,11 @@ DOC
     options[:color_block] = color_block || false
   end
 
-  parser.on("-o", "--ouput=OUTPUT", "save ascii frame to output dirname") do |output|
+  parser.on("-o", "--ouput=OUTPUT", "save ascii frames to the output directory") do |output|
     options[:output] = output
   end
 
-  parser.on("-p", "--play_dir=PLAY_DIRNAME", "input ascii frames dirname to play") do |play_dir|
+  parser.on("-p", "--play_dir=PLAY_DIRNAME", "input the ascii frames directory to play") do |play_dir|
     options[:play_dir] = play_dir
   end
 

data/lib/convert2ascii/version.rb

@@ -1,3 +1,3 @@
 module Convert2Ascii
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: convert2ascii
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mark24