X-Git-Url: http://git.hcoop.net/clinton/bobotpp.git/blobdiff_plain/a0982f52ffe4e39d13b721af95de17b2a78ac7a8..94a034218b31a931763efc2b1fca6699af471653:/README diff --git a/README b/README index e18c7d4..1d5757b 100644 --- a/README +++ b/README @@ -1,28 +1,17 @@ -THIS IS BOBOT++ VERSION 2.1 (this file is also -*- text -*-) +THIS IS BOBOT++ VERSION 2.3 (this file is also -*- text -*-) === REQUIREMENTS (Compile) === -Bobot++ 2.1 relies on CommonC++ 2 -(http://www.gnu.org/software/commoncpp/) 1.0.13 (at least). Newer -version are compatible (at the time of writing, Debian unstable is -only up to 1.0.13 so I targeted that since I don't need the features -of 1.3 and relying on packages available in Debian makes it easier to -install for everyone). - -NOTE: CC++2 1.0 is newer than CC++ 1.0! - -Guile Scheme (http://www.gnu.org/software/guile/) Version 1.6 is used +Guile Scheme (http://www.gnu.org/software/guile/) Version 1.8+ is used for scripting. It is optional and may be disabled by passing `--disable-scripting' to configure. === 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' @@ -37,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. @@ -57,4 +47,5 @@ License version 2 or later. See the COPYING file for details. === CONTACT INFO === -Clinton Ebadi (Maintainer) \ No newline at end of file +Clinton Ebadi (Maintainer) +Official IRC Channel: #bobotpp on freenode