Go to file
Jeremy Fincher 1c86e6f40c Removed shrink command since it's mostly unnecessary since we got the mores. 2003-09-24 04:19:23 +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 Added dict command. 2003-09-03 09:38:17 +00:00
plugins Removed shrink command since it's mostly unnecessary since we got the mores. 2003-09-24 04:19:23 +00:00
sandbox Removed friendly.py; it needs to be renamed Friendly.py and stuck in plugins/ 2003-03-27 08:47:25 +00:00
scripts Fix for jamessan's bug. 2003-09-16 05:59:07 +00:00
src Updated IrcObjectProxyRegexp.reply to match the interface of IrcObjectProxy.reply. 2003-09-23 20:45:00 +00:00
test Removed shrink command since it's mostly unnecessary since we got the mores. 2003-09-24 04:19:23 +00:00
tools Guarded inserts into sys.path. 2003-08-30 19:20:08 +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 Newest list of stuff for beta release. 2003-09-01 21:04:55 +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!