Go to file
Jeremy Fincher b1f0cb6647 Removed a gratuitous world.ircs.remove, probably fixing bug #801438. 2003-09-25 08:18:36 +00:00
docs Added documentation for the interface to the IrcMsg class. 2003-09-22 09:34:18 +00:00
examples Updated EXAMPLE, finally :) 2003-09-14 03:33:02 +00:00
others Initial checkin of the distutils stuff. 2003-09-24 07:19:54 +00:00
plugins Removed a gratuitous world.ircs.remove, probably fixing bug #801438. 2003-09-25 08:18:36 +00:00
sandbox Removed, old files. 2003-09-24 05:13:08 +00:00
scripts Made the template have a hole for the python interpreter, to be filled in with the one the script is called with. 2003-09-25 07:20:44 +00:00
src Changed @help to @syntax, @morehelp to @help, and changed the output of @morehelp to be prettier. 2003-09-25 08:14:46 +00:00
test Changed @help to @syntax, @morehelp to @help, and changed the output of @morehelp to be prettier. 2003-09-25 08:14:46 +00:00
tools Removed, old file. 2003-09-24 05:11:24 +00:00
.cvsignore Initial revision 2003-03-12 06:26:59 +00:00
ACKS Added some stuff, though it still needs much more. 2003-09-17 07:26:43 +00:00
BUGS Added link to SF.net page 2003-03-25 23:21:42 +00:00
LICENSE Initial revision 2003-03-12 06:26:59 +00:00
README Added some information, removed others, etc. 2003-04-02 10:21:14 +00:00
TODO Updated. 2003-09-24 06:00:36 +00:00
__init__.py Initial checkin of the distutils stuff. 2003-09-24 07:19:54 +00:00
setup.py Added test for the Python version so people could understand when their bot wouldn't run. Now it won't even install :) 2003-09-25 02:46:33 +00:00

README

EVERYONE:
---------
Read LICENSE.  It's a 2-clause BSD license, but you should read it anyway.


DEVELOPERS:
------------
Read OVERVIEW to see what the modules are used for.  Read EXAMPLE to see some
examples of callbacks and command written for the bot.  Read STYLE if you ever
wish to contribute.

Use PyChecker.  Believe me, it makes things better.  A sample
.pycheckrc file is included as tools/pycheckrc.  Copy this to your
~/.pycheckrc and you'll be able to check your code with the same
stringent guidelines I've found useful to check my code.


USERS:
------
All commands should be run from the root directory, never from any
subdirectory such as conf/, log/, src/, or plugins/.

All you have to do to get a working bot is run scripts/setup.py and
answer the questions!