Fixed line buffering, added example.

[botbot.git] / README

diff --git a/README b/README
index f64a7fb..eb2a0c5 100644 (file)
--- a/README
+++ b/README
@@ -10,6 +10,19 @@ The logic behind message responses is handled by a function
 defined in a text file provided at runtime, making the actual
 functioning of the bot highly (overly?) configurable.
 
+Installation
+------------
+
+You'll need a Chicken 5 build environment to compile the bot.
+With this, and the necessary eggs in place, use
+
+     csc bot.scm
+
+to produce the binary.  Move this to wherever makes you happy.
+
+Note: "necessary eggs" includes machable, srfi-1, srfi-13, srfi-18,
+      tcp6 and openssl.
+
 Usage
 -----
 
@@ -29,6 +42,11 @@ The arguments are:
     -c/--channel CHANNEL: specify a channel for the bot to join on connecting
         (Default behaviour is to not join any channel.)
 
+    -v/--verbose: increase verbosity level (default 0, max 2)
+
+    -a/--allow-reload: allow hot-reloading of procedure file.
+        Reloading is initiated when a "bbreload" command is received.
+
     proc-file: name of file defining bot logic (see below)
 
     host: irc server hostname