X-Git-Url: http://git.hcoop.net/clinton/bobotpp.git/blobdiff_plain/2e20c3e1445f1539b3164af29da30654942f6a15..186fb4261355b2ab03f9fa6f28ff7c71ef371584:/README

diff --git a/README b/README
dissimilarity index 80%
index d377da7..bfdfb53 100644
--- a/README
+++ b/README
@@ -1,18 +1,51 @@
-THIS IS BOBOT++ VERSION 2.1 (this file is also -*- text -*-)
-
-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 binary is now named bobotpp because of automake's choking on ++ in
-rule names. Make install isn't really needed because bobotpp reads
-it's config from the current dir. 2.1 will change this too.
-
-2.1 is not guaranteed to compile anywhere.
-
-Please read the doc in the "doc" directory.
-
-This program is distributed under the terms of the GNU General Public
-License version 2 or later. See the COPYING file for details.
-
-NEW as of version 1.30: The syntax for the "channel =" option of bot.conf.
-See the examples for new syntax.
+THIS IS BOBOT++ VERSION 2.2 (this file is also -*- text -*-)
+
+=== REQUIREMENTS (Compile) === 
+
+Guile Scheme (http://www.gnu.org/software/guile/) Version 1.6 is used
+for scripting. It is optional and may be disabled by passing
+`--disable-scripting' to configure.
+
+=== BACKGROUND ===
+
+This is the new stable. Upgrading from 2.0 is recommended, especially
+if you use the scripting interface.
+
+=== 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'
+should be enough to update your scripts. The bot-* functions are
+defined as aliases for the bot:* functions in bobot-utils.scm, which
+is autoloaded by bobot++.
+
+The binary is now named bobotpp because of automake choking on ++ in
+rule names. In order for the bot to work properly, you must 'make
+install' it so that bobot-utils.scm is installed and can be loaded for
+scripts to use (unless you have Guile disabled).
+
+=== IMPORTANT NOTES ===
+
+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 ===
+
+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.
+
+=== LICENSE ===
+
+This program is distributed under the terms of the GNU General Public
+License version 2 or later. See the COPYING file for details.
+
+=== CONTACT INFO ===
+
+Clinton Ebadi <clinton@unknownlamer.org> (Maintainer)
+Official IRC Channel: #bobotpp on freenode
\ No newline at end of file