[project @ 2005-07-07 21:19:26 by unknown_lamer]
[clinton/bobotpp.git] / README
diff --git a/README b/README
index 82ce78f..bfdfb53 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-THIS IS BOBOT++ VERSION 2.1 (this file is also -*- text -*-)
+THIS IS BOBOT++ VERSION 2.2 (this file is also -*- text -*-)
 
 === REQUIREMENTS (Compile) === 
 
@@ -8,12 +8,10 @@ for scripting. It is optional and may be disabled by passing
 
 === BACKGROUND ===
 
-This is the unstable tree. 2.0 is what you want to use if you don't
-want your scripts to break every other day. The Scheme interface is
-going to remain essentially the same, but the config system and
-internal structure of the bot are very different.
+This is the new stable. Upgrading from 2.0 is recommended, especially
+if you use the scripting interface.
 
-=== BIG CHANGES FROM STABLE ===
+=== BIG CHANGES FROM 2.0 ===
 
 The biggest change is that all bot-* functions are now
 bot:*. A simple 'perl -pi -e s/bot-/bot:/g SCRIPT1 SCRIPT2 .. SCRIPTN'
@@ -28,16 +26,17 @@ scripts to use (unless you have Guile disabled).
 
 === IMPORTANT NOTES ===
 
-*** 2.1 is not guaranteed to compile anywhere. ***
-(But PLEASE email me if it doesn't!)
+2.2 should compile on GNU/Linux and FreeBSD. There are some
+compatibility hacks for HP/UX, but they may not works as I don't have
+access to an HP/UX machine. I'm not sure if it builds on other
+systems, if it does please email me. If it doesn't, please email so I
+can fix it.
 
 === DOCUMENTATION ===
 
-Please read the doc in the "doc" directory.
-Also see bobot++.texinfo, which should be an ok set of docs on how to
-configure and use Bobot++, even if it is horribly incomplete. You
-should still read the old doc in the doc directory because it is more
-complete.
+There is a texinfo manual. It should be complete. "info bobot++" to
+read it. It has sections on configuring, running, and scripting the
+bot. Suggestions are welcome.
 
 bobotpp --help is also helpful.
 
@@ -48,4 +47,5 @@ License version 2 or later. See the COPYING file for details.
 
 === CONTACT INFO ===
 
-Clinton Ebadi <clinton@unknownlamer.org> (Maintainer)
\ No newline at end of file
+Clinton Ebadi <clinton@unknownlamer.org> (Maintainer)
+Official IRC Channel: #bobotpp on freenode
\ No newline at end of file