Support for wide char, 24-bit RGB, ghosting effects.

1 files changed, 23 insertions, 8 deletions

diff --git a/README.md b/README.md
index 994cc08..0976343 100644
--- a/README.md
+++ b/README.md
@@ -2,25 +2,40 @@
 
 ![example](example.png)
 
-> All I see now is blonde, brunette, redhead.
+> Do not try and bend the spoon, that's impossble. Instead, only try to realize the truth. There is no spoon.
 
- -- _Cypher_
+ -- _Spoon Boy_
 
-# Overview
+## Overview
 
-Pure C implementation of the famous [digital rain](https://en.wikipedia.org/wiki/Matrix_digital_rain) effect from _The Matrix_ series. While the implementation was inspired by [fakesteak](https://github.com/domsson/fakesteak), this implementation uses the default colours of the terminal to match the overall theme of the setup. Colour of the first drop can be changed by changing `ANSI_COL_DROP` which is set to white by default.
+Pure C implementation of the famous [digital rain](https://en.wikipedia.org/wiki/Matrix_digital_rain) effect from _The Matrix_ series for Linux inspired by [fakesteak](https://github.com/domsson/fakesteak). While trying to keep the simplicity and lightweightness of fakesteak as much as possible, I have added the following characteristics.
 
-Glitching effect is implemented using unicode characters, hence the terminal needs to support them or else change the glitch code characters to ascii before compiling.
+ - Simulation pattern is closer to the one seen in the background while Neo and Cypher were talking in the first Matrix movie.
+ - Ghosting effect of monochrome displays.
+ - Truecolor support and simple colour customisation options to match the theme of the setup for ricing. 
+ - Unicode support.
 
-# Building
+## Requirements and Dependencies
 
-All the code is in a single file (src/main.c) and has no dependencies. So, you can compile it any way you like. If you have autotools installed you can build the project with:
+ - Terminal emulator with support for 24-bit RGB colours and unicode characters.
+
+## Customisation
+
+ - Character set: set `UNICODE_MIN` and `UNICODE_MAX` for the [unicode block](https://en.wikipedia.org/wiki/List_of_Unicode_characters) you like to use (e.g. 0x30A1 and 0x30F6 for Katakana).
+ - Colours: set the RGB values of `COLOR_BG_*`, `COLOR_HD_*` and `COLOR_TL_*` for background, head and the tail characters respectively.
+ - Rain attributes: set `RAIN_RATE` and `RAIN_DENSITY` to change the speed and the density of the rain. 
+
+## Building and Running
+
+All the code is in a single file (src/main.c) and has no external dependencies. You can compile it any way you like. If you have autotools installed you can build and run using the following commands.
 ```
 autoreconf -i
 cd build/
 ../configure
 make
+./amx
 ```
-# Contributing
+
+## Contributing
 
 Code is hosted on [sourcehut](https://git.sr.ht/~sadeep/matrix-digital-rain). Please submit your patches there or via email to sadeep@asciimx.com ([PGP key](http://www.asciimx.com/sadeep.asc)).