---
+++
@@ -1,3 +1,70 @@
-$ cmake .
-$ make
-$ ./input.py 3 | ./ngrapher
+ngrapher
+========
+
+ngrapher is a simple tool to create realtime colored ncurses graphs from numerical data.
+
+Example
+-------
+
+To display load average of the system, we can use the following command:
+
+::
+
+ $ (while true ; do sed -e 's/\(.* .* .*\) .* .*/\1/' < /proc/loadavg ; sleep 5;done) \
+ | ./ngrapher
+
+It prints three values every five seconds, and as they are piped into ngrapher, you see this beautiful plot:
+
+::
+
+ 0 ^ cc c
+ | cc ccccc ccc
+ | cc
+ |
+ |
+ |
+ |
+ |
+ | a
+ |
+ | a
+ |
+ | b bb
+ | bbb bbb b
+ | a b a bbbb
+ | a a
+ | a a
+ | a a
+ | a
+ | a
+ |
+ |
+ |
+ |
+ |
+ |
+ 0 |
+ 0 -37-------------------------------------------------
+
+Get it
+Download sources from git repository:
+
+::
+
+ $ git clone git://git.symlink.me/pub/romain/ngrapher.git
+
+Then, compile it:
+
+::
+
+ $ cmake .
+ $ make
+
+You can now play with this tool, for example with random data:
+
+::
+
+ $ ./input.py | ./ngrapher
+
+Screenshots
+
Generated with KisssPM