From: rjones <rjones>
Date: Thu, 28 Jun 2007 20:57:49 +0000 (+0000)
Subject: Added README file.
X-Git-Url: http://git.annexia.org/?p=xavierbot.git;a=commitdiff_plain;h=cc231442a67a455523ae8ea36c49f9f2a31bc230

Added README file.
---

diff --git a/MANIFEST b/MANIFEST
index 7751be5..33b71c7 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -7,5 +7,6 @@ init.in
 ocamlbotwrapper.c
 ocamlbotwrapper.c.in
 pa_noexternal.ml
+README
 xavierbot.pl
 xavierbot.pl.in
diff --git a/Makefile.config b/Makefile.config
index ed97661..a62fd57 100644
--- a/Makefile.config
+++ b/Makefile.config
@@ -1,4 +1,4 @@
-# $Id: Makefile.config,v 1.2 2007/06/28 20:49:10 rjones Exp $
+# $Id: Makefile.config,v 1.3 2007/06/28 20:57:49 rjones Exp $
 
 PACKAGE := xavierbot
 VERSION := 0.1
@@ -27,10 +27,16 @@ OCAML=/usr/bin/ocaml
 # OCaml command user.
 OCAMLUSER=nobody
 
-
-# If you want to run it without installing, leave the
-# following uncommented.  You will also need to create
-# directory $(CHROOTDIR), compile everything, and make
-# ocamlbotwrapper be chown root.root, chmod ug+s.
+#----------------------------------------------------------------------
+#
+# If you want to run the bot without installing, leave the
+# following lines uncommented.
+#
+# You will also need to create directory $(CHROOTDIR),
+# compile everything, and then:
+#
+#   chown root.root ocamlbotwrapper
+#   chmod ug+s ocamlbotwrapper
+#
 INITSCRIPT=init
 WRAPPER=./ocamlbotwrapper
diff --git a/README b/README
new file mode 100644
index 0000000..2cd54fb
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+I am xavierbot, an OCaml toplevel bot for IRC.
+
+<rwmjones>    let hello () = print_endline "hello, world";;
+<xavierbot>   val hello : unit -> unit = <fun>
+<rwmjones>    hello ();;
+<xavierbot>   hello, world
+<xavierbot>   - : unit = ()
+
+I am Public Domain.
+
+I was originally written by Richard W.M. Jones <rich@annexia.org>.
+
+To run me, you will need the following packages:
+
+  ocaml >= 3.10.0
+  findlib
+  perl
+  POE::Component::IRC
+  POE::Wheel::Run
+
+Please read Makefile.config for configuration information.