catpix_mini 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbe7bb291ed03d1f3f945fe22fd96230016be3e1
-  data.tar.gz: 89b52d847d8e76dfa0c8aa69eabcfbb3fbfd7ace
+  metadata.gz: 0bc8d5334f7b77bb8f0c68953cf19c62741003ca
+  data.tar.gz: ed5aeffb958c1db66fc3dbfe2d622c5d524be086
 SHA512:
-  metadata.gz: 259af61caf5768dd2eeea81ca932e840233206275036d36b8fd8afafaf0af569664c2f0e1713e584dacab118881350c4ddc07a6fdf70148df57544e00b1e7c44
-  data.tar.gz: 0051a1e22e34b494382ef415947e4f74e2edc30eb3669ddc51fb6872619773c30c5e9151eab056a04a020535b69ab9a93d5a06fe56df818810e7541bb76ead5a
+  metadata.gz: 34baa5e8b5f8a2adc24b208120ea7c42c5861bdef85f071947b640524556496e66e2c09def65bd430ffb4895eadad47cfcf63ac7d9702e9911ce02dcebbd3048
+  data.tar.gz: a72af0d8cbef4a902e067af1b7588c3e60605047744784e4fb0ba9778726b067bcef5197b26df8a708fe742715a882cdeb9a03614524d7d93e84e8f86896532b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.0
+The beginning of time
+
+## 0.1.1
+- Fixed crash if displaying full width image when catpix_mini being included by another gem.

data/README.md

@@ -2,18 +2,26 @@
 
 Renders images in the terminal.
 
-## Why not a fork but clone
+This project is a "port" from [pazdera's catpix repo](https://github.com/pazdera/catpix). 
 
-This project is a "port" from [pazdera's catpix repo](https://github.com/pazdera/catpix).
-The original project is based on RMagick while this one is based on MiniMagick. I was spending
-time finding solutions with MiniMagick but could not find any hence I decided to port from the
-original.
+The original project is based on RMagick while this one is compatible with MiniMagick. I made this project in hope that MiniMagick would speed up the original gem and some other mini-magick fans will be able to use this awesome feature in their minimagick projects.
 
+I would probably switch over to rmagick for serious projects in the future. I just did not want to invest effort in switching from mini-magick to rmagick in my main app so I think this 1 day work is pretty useful.
+
+## Example
+
+    $ catpix_mini pokemon.gif
+    
 ![Pokemon](http://radek.io/assets/images/posts/catpix/pokemon.png)
 
-## More examples
+## More examples and options
+
+    $ catpix_mini panda.png -c xy
+    $ catpix_mini trophy.png -w 0.5 -h 0.5
+    $ catpix_mini tux.png -c xy -r high # enforce high resolution
 
-For more examples and APIs please check out [pazdera's catpix repo](https://github.com/pazdera/catpix). They should be very similar at this point except that the binary name is changed from `catpix` to `catpix_mini`.
+For more examples and APIs please check out [pazdera's catpix repo](https://github.com/pazdera/catpix). 
+They should be very similar at this point except that the binary name is changed from `catpix` to `catpix_mini`.
 
 ## Performances
 
@@ -25,7 +33,7 @@ has upper advantage when rendering large image while catpix is slightly faster f
     time catpix ./img/benchmark.jpg  
     48.25s user 0.56s system 87% cpu 55.578 total
 
-    catpix_mini ./img/benchmark.jpg  
+    time catpix_mini ./img/benchmark.jpg  
     42.26s user 0.76s system 83% cpu 51.647 total
 
 
@@ -36,11 +44,16 @@ more proper tests and let me know your results.
 
 ## Quality
 
-RMagick return pixels colours in 16bits by default while MiniMagick is only 8 bits therefor the
+RMagick return pixels' colours in `16-bit` by default while MiniMagick colour is only `8-bit` therefor the
 quality at high-res looks slightly better in catpix compared to catpix-mini.
 
 Only slightly because the quality printed out to terminal is not too insanely detailed to begin with.
 
+## Transparency
+
+Due to the performance advantage is not too impressive, I have not invested time to do pixel reading per pixel to detect alpha channel for the image. Therefor transparent images printed out by catpix_mini will be in white-background.
+
+Another disadvantage of mini-magick.
 
 ## About Me
 

data/lib/catpix_mini/private.rb

@@ -128,7 +128,7 @@ module CatpixMini
   #############################################################################
 
   def self.prep_vert_margin(size, colour)
-    tw = get_screen_size
+    tw, th = get_screen_size
 
     buffer = ""
     if high_res?

data/lib/catpix_mini/version.rb

@@ -3,5 +3,5 @@
 
 module CatpixMini
   # Version of the gem
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catpix_mini
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Radek Pazdera
@@ -143,6 +143,7 @@ files:
 - Rakefile
 - bin/catpix_mini
 - catpix_mini.gemspec
+- img/benchmark.jpg
 - lib/catpix_mini.rb
 - lib/catpix_mini/private.rb
 - lib/catpix_mini/version.rb