[project @ 2005-01-08 06:24:08 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 Bobot++ 2.1 relies on CommonC++ 2
6 (http://www.gnu.org/software/commoncpp/) 1.0.13 (at least). Newer
7 version are compatible (at the time of writing, Debian unstable is
8 only up to 1.0.13 so I targeted that since I don't need the features
9 of 1.3 and relying on packages available in Debian makes it easier to
10 install for everyone).
11
12 NOTE: CC++2 1.0 is newer than CC++ 1.0!
13
14 Guile Scheme (http://www.gnu.org/software/guile/) Version 1.6 is used
15 for scripting. It is optional and may be disabled by passing
16 `--disable-scripting' to configure.
17
18 === BACKGROUND ===
19
20 This is the unstable tree. 2.0 is what you want to use if you don't
21 want your scripts to break every other day. The Scheme interface is
22 going to remain essentially the same, but the config system and
23 internal structure of the bot are very different.
24
25 === BIG CHANGES FROM STABLE ===
26
27 The biggest change is that all bot-* functions are now
28 bot:*. A simple 'perl -pi -e s/bot-/bot:/g SCRIPT1 SCRIPT2 .. SCRIPTN'
29 should be enough to update your scripts. The bot-* functions are
30 defined as aliases for the bot:* functions in bobot-utils.scm, which
31 is autoloaded by bobot++.
32
33 The binary is now named bobotpp because of automake choking on ++ in
34 rule names. In order for the bot to work properly, you must 'make
35 install' it so that bobot-utils.scm is installed and can be loaded for
36 scripts to use (unless you have Guile disabled).
37
38 === IMPORTANT NOTES ===
39
40 *** 2.1 is not guaranteed to compile anywhere. ***
41 (But PLEASE email me if it doesn't!)
42
43 === DOCUMENTATION ===
44
45 Please read the doc in the "doc" directory.
46 Also see bobot++.texinfo, which should be an ok set of docs on how to
47 configure and use Bobot++, even if it is horribly incomplete. You
48 should still read the old doc in the doc directory because it is more
49 complete.
50
51 bobotpp --help is also helpful.
52
53 === LICENSE ===
54
55 This program is distributed under the terms of the GNU General Public
56 License version 2 or later. See the COPYING file for details.
57
58 === CONTACT INFO ===
59
60 Clinton Ebadi <clinton@unknownlamer.org> (Maintainer)