# HG changeset patch
# User Teemu Piippo <crimsondusk64@gmail.com>
# Date 1418694800 -7200
# Node ID 44a2c0b2e7d70f51eda3fa2cade4d5206942da3e
# Parent  cdf3c8af1545b16b560c9509797f7cc2cbe58aa8
- readme updated

diff -r cdf3c8af1545 -r 44a2c0b2e7d7 README.md
--- a/README.md	Tue Dec 16 03:44:05 2014 +0200
+++ b/README.md	Tue Dec 16 03:53:20 2014 +0200
@@ -1,1 +1,21 @@
-Text-based RCON utility for Zandronum
+zfc9000
+---------
+
+zfc9000 is a text-based RCON utility for the Zandronum Doom source port.
+
+Features:
+
+* Fully textual, can be used over SSH for instance
+* Supports in-game colorcodes
+* Input history
+* A subset of readline shortcuts
+* a nicklist
+
+To use, either:
+
+* use the command line: ```zfc9000 <address> <password>```
+* use Ctrl-N within the application to create a new connection
+
+To compile, clone the sources off the mercurial repository and check out the version desired. Ensure you have the proper ncurses libraries installed, e.g. ```libncurses5-dev``` and ```libncursesw5-dev``` on Ubuntu. Compile using cmake.
+
+Binaries are provided but these may or may not work on your system.