Merge branch 'release-v2.0.0'

* CharStreams now have size and position, only latest char is stored
* Each frame now re-renders only the stream heads and tails
* Added DEBUG mode and setting
* Removed ASYNC_DAMPER setting
* Added STREAM_SIZE_MULT setting
* Added ESC to default EXIT_KEYS

README.md

@@ -9,42 +9,42 @@ a classic matrix terminal animation using curses
 ### Dependencies
 
 * python3
-* font with Japanese Katakana support (unicode `0xff66-0xff9d`)
+* font with Japanese Katakana support (unicode `0xff66`-`0xff9d`)
 
 ### Installation
 
 ```sh
 #!/usr/bin/env sh
 curl https://raw.githubusercontent.com/stefrush/enterthematrix/master/enterthematrix -o /usr/local/bin/enterthematrix
 chmod +x /usr/local/bin/enterthematrix
+enterthematrix --version
 ```
 
 ### Usage
 
 ```
-usage: enterthematrix [-h] [-v] [-b INT] [-t INT] [-n FLOAT] [-a FLOAT] [-l FLOAT] [-e KEY [KEY ...]] [-c INT] [-d FLOAT] [--use-async] [--no-use-async]
+enterthematrix [-h] [-v] [-b INT] [-t INT] [-n FLOAT] [-a FLOAT] [-l FLOAT] [-m INT] [-e KEY [KEY ...]] [--use-async] [--no-use-async] [-d]
 
 optional arguments:
   -h, --help            show this help message and exit
   -v, --version         show program's version number and exit
   -b INT, --bandwidth INT
-                        set the maximum number of character animation streams per text column [0-inf) (default: 8)
+                        set the maximum number of character animation streams per text column [0-inf) (default: 2)
   -t INT, --throughput INT
-                        set the number of character animation streams to create per animation frame [0-inf) (default: 8)
+                        set the number of character animation streams to create per animation frame [0-inf) (default: 4)
   -n FLOAT, --neos-influence FLOAT
                         follow the white rabbit [0-1] (default: 0.0064)
   -a FLOAT, --animation-interval FLOAT
-                        set the amount of time in seconds between animation frames [0-inf) (default: 0.03)
+                        set the amount of time in seconds between animation frames [0-inf) (default: 0.0425)
   -l FLOAT, --limiter FLOAT
                         limit the maximum number of streams by a factor of the limiter value [0-1) (default: 0)
+  -m INT, --max-cols INT
+                        set the maximum number of text columns to animate [1-inf) (default: 1280)
   -e KEY [KEY ...], --exit-keys KEY [KEY ...]
-                        set the keys to initiate exit; should be space separated list eg. "q e x" (default: ('q', 'Q', 'e', 'E'))
-  -c INT, --max-cols INT
-                        set the maximum number of text columns to animate (default: 1280)
-  -d FLOAT, --async-damper FLOAT
-                        slow async frame animations by a factor of the damper value [0-1) (default: 0.25)
+                        set the keys to initiate exit; should be a space separated list eg. "e E" (default: ('q', 'Q', '\x1b'))
   --use-async           turn on async frame rendering in supported environments (default: True)
   --no-use-async        turn off async frame rendering in supported environments (default: False)
+  -d, --debug           show program runtime information during the animation (default: False)
 ```
 
 ### License