Go to file
Jeremy Fincher ca4ad3882f Initial import. 2003-04-22 08:27:11 +00:00
docs New style guidelines for SQL. 2003-03-26 00:15:08 +00:00
examples Initial revision 2003-03-12 06:26:59 +00:00
others Added allowed escaped strings to shlex.py 2003-04-14 07:17:48 +00:00
plugins Syntax fix for SQL. 2003-04-21 13:07:01 +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 Moved file writing to later in the run. 2003-04-16 07:13:29 +00:00
src Initial import. 2003-04-22 08:27:11 +00:00
test Initial import. 2003-04-22 08:27:11 +00:00
tools Added vim:set ... : strings to source in order to keep file formatting 2003-03-24 08:41:19 +00:00
.cvsignore Initial revision 2003-03-12 06:26:59 +00:00
ACKS Initial revision 2003-03-12 06:26:59 +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

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!