Go to file
2003-10-05 12:56:56 +00:00
docs Changed the anti-capability prefix to - instead of !. 2003-10-05 11:13:20 +00:00
examples Changed baseplugin not to require 'from baseplugin import *' because fix is now munging builtins. 2003-10-05 12:56:56 +00:00
others Updated the Amazon Web Services URL 2003-09-30 19:00:53 +00:00
plugins Changed baseplugin not to require 'from baseplugin import *' because fix is now munging builtins. 2003-10-05 12:56:56 +00:00
sandbox Removed, old files. 2003-09-24 05:13:08 +00:00
scripts Optparsified. 2003-10-02 05:49:40 +00:00
src Renamed baseplugin to plugins. 2003-10-05 12:48:28 +00:00
test Added a few more asserts to *SetTestCase.testReprEval. 2003-10-05 11:57:25 +00:00
tools Initial checkin. 2003-10-04 14:55:17 +00:00
__init__.py Initial checkin of the distutils stuff. 2003-09-24 07:19:54 +00:00
.cvsignore Initial revision 2003-03-12 06:26:59 +00:00
ACKS Forgot sweede, dude! 2003-10-05 04:51:14 +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 Updated for the 0.72.0 release. 2003-09-29 06:51:12 +00:00
setup.py Added unum subpackage (and unum.units). 2003-10-03 19:02:39 +00:00
TODO Updated. 2003-09-24 06:00:36 +00:00

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:
------
First, you gotta have Python 2.3 for this.  That's alright, though,
because Python 2.3 rocks, and you should have it anyway :)

Assuming "python" is in your path and points to Python 2.3 or newer,
then you need to run this:

python setup.py install

from the untarred directory to install the source files.  Then just
run supybot-wizard.py (it's been installed in your path somewhere) to
create a script that will run your bot as you answered the questions
in the wizard.

If you have any trouble, feel free to swing by #sourcereview on
irc.freenode.net or irc.oftc.net (we have a supybot there relaying, so
either network works) and ask questions.  We'll be happy to help
wherever we can.  And by all means, if you find anything hard to
understand or think you know of a better way to do something, *please*
post it on Sourceforge.net so we can improve the bot!