[clinton/bobotpp.git] / README

THIS IS BOBOT++ VERSION 2.1 (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 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.

=== BIG CHANGES FROM STABLE ===

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.1 is not guaranteed to compile anywhere. ***
(But PLEASE email me if it doesn't!)

=== 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.

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)
Commit	Line	Data
2e20c3e1	1	THIS IS BOBOT++ VERSION 2.1 (this file is also -- text --)
2e20c3e1	2
a0982f52	3	=== REQUIREMENTS (Compile) ===
a0982f52	4
a0982f52	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
2e20c3e1	11	This is the unstable tree. 2.0 is what you want to use if you don't
a0982f52	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
91dddabd	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++.
2e20c3e1	23
a0982f52	24	The binary is now named bobotpp because of automake choking on ++ in
91dddabd	25	rule names. In order for the bot to work properly, you must 'make
91dddabd	26	install' it so that bobot-utils.scm is installed and can be loaded for
a0982f52	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!)
2e20c3e1	33
a0982f52	34	=== DOCUMENTATION ===
2e20c3e1	35
2e20c3e1	36	Please read the doc in the "doc" directory.
91dddabd	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.
2e20c3e1	43
a0982f52	44	=== LICENSE ===
a0982f52	45
2e20c3e1	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
a0982f52	49	=== CONTACT INFO ===
	50
	51	Clinton Ebadi <clinton@unknownlamer.org> (Maintainer)