initial commit

1 files changed, 26 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..09a06c7
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+sic - simple irc client
+-----------------------
+
+sic is an extremly fast, small and simple irc client.  It reads commands from
+standard input and prints all server output to standard output. It multiplexes
+also all channel traffic into one output, that you don't have to switch
+different channel buffers, that's actually a feature.
+
+Installation
+------------
+Edit config.mk to match your local setup. sic is installed into
+/usr/local by default.
+
+Afterwards enter the following command to build and install sic 
+(if necessary as root):
+
+    $ make clean install
+
+Running sic
+-----------
+Simply invoke the 'sic' command with the required arguments.
+
+
+Configuration
+-------------
+No configuration is needed.