[project @ 2005-06-23 06:20:44 by unknown_lamer]
[clinton/bobotpp.git] / README
1 THIS IS BOBOT++ VERSION 2.1 (this file is also -*- text -*-)
2
3 === REQUIREMENTS (Compile) ===
4
5 Guile Scheme (http://www.gnu.org/software/guile/) Version 1.6 is used
6 for scripting. It is optional and may be disabled by passing
7 `--disable-scripting' to configure.
8
9 === BACKGROUND ===
10
11 This is the unstable tree. 2.0 is what you want to use if you don't
12 want your scripts to break every other day. The Scheme interface is
13 going to remain essentially the same, but the config system and
14 internal structure of the bot are very different.
15
16 === BIG CHANGES FROM STABLE ===
17
18 The biggest change is that all bot-* functions are now
19 bot:*. A simple 'perl -pi -e s/bot-/bot:/g SCRIPT1 SCRIPT2 .. SCRIPTN'
20 should be enough to update your scripts. The bot-* functions are
21 defined as aliases for the bot:* functions in bobot-utils.scm, which
22 is autoloaded by bobot++.
23
24 The binary is now named bobotpp because of automake choking on ++ in
25 rule names. In order for the bot to work properly, you must 'make
26 install' it so that bobot-utils.scm is installed and can be loaded for
27 scripts to use (unless you have Guile disabled).
28
29 === IMPORTANT NOTES ===
30
31 *** 2.1 is not guaranteed to compile anywhere. ***
32 (But PLEASE email me if it doesn't!)
33
34 === DOCUMENTATION ===
35
36 Please read the doc in the "doc" directory.
37 Also see bobot++.texinfo, which should be an ok set of docs on how to
38 configure and use Bobot++, even if it is horribly incomplete. You
39 should still read the old doc in the doc directory because it is more
40 complete.
41
42 bobotpp --help is also helpful.
43
44 === LICENSE ===
45
46 This program is distributed under the terms of the GNU General Public
47 License version 2 or later. See the COPYING file for details.
48
49 === CONTACT INFO ===
50
51 Clinton Ebadi <clinton@unknownlamer.org> (Maintainer)