Go to file
Jeremy Fincher f39b35eb9b Must've forgotten this one earlier. 2003-04-11 20:52:39 +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 Upgrade to asyncore from 2.3; removed fcntl dependent stuff (since I don't have it on my system). 2003-04-08 07:04:57 +00:00
plugins Must've forgotten this one earlier. 2003-04-11 20:52:39 +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 Template forgot advanced argument to configure. 2003-04-09 19:29:45 +00:00
src Changed dictionaries in IrcState to use ircutils.IrcDict. 2003-04-11 20:46:23 +00:00
test Fixed bug (no __delitem__) in IrcDict and added test. 2003-04-11 20:44:29 +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!