Inital Checkin - should be working

darcs-hash:20090504042243-82ea9-350eb26dd8561a18efc98dd5d5f7a730ce37cdc7.gz

1 files changed, 43 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..dfec6a6
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,43 @@
+USAGE
+~~~~~
+http://wiki.debian.org/MeatBot
+
+Inspired by http://wiki.debian.org/MeetBot
+
+/usr/share/doc/supybot/GETTING_STARTED.gz (on Debian systems) provides
+information on configuring supybot the first time, including taking
+ownership the first time.
+
+
+
+INSTALLATION
+~~~~~~~~~~~~
+
+Requirements: 
+* pygments (debian package python-pygments) (for pretty IRC logs).
+
+* Install supybot.  You can use supybot-wizard to make a bot 
+  configuration.
+
+  * Don't use a prefix character.  (disable this:
+      supybot.reply.whenAddressedBy.chars: 
+    in the config file - leave it blank afterwards.)
+
+* Move the MeatBot directory into your plugins directory of Supybot.
+
+* Make supybot join any channels you are interested in.  The wizard
+  handles this for the first part.  After that, I guess you have to
+  learn about supybot (I don't know enough yet...).  If the plugin is
+  loaded, it is active on ALL channels the bot is on.  You can also
+  command the bot after it's online.
+
+* Make sure the plugin is loaded.
+    supybot.plugins: Admin Misc User MeatBot Owner Config Channel
+  (can also control loading after the bot is started)
+
+Supybot does a lot, but I don't know much about it.  Hopefully Supybot
+expert users can enlighten me as to better ways to do things.
+
+In particular, supybot has a large configuration system, which I know
+nothing about.  It may be worth hooking MeatBot into that system.
+