Added README file.

[xavierbot.git] / README

diff --git a/README b/README
new file mode 100644 (file)
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.