Go to file
2003-12-10 18:49:45 +00:00
docs Updated. 2003-11-25 10:22:50 +00:00
examples Updated examples. 2003-11-15 08:23:11 +00:00
others Finished flushing out Amazon's use of the web services. Added actual tests to 2003-12-04 01:56:50 +00:00
plugins Now Todo.remove can take multiple taskids to be removed instead of just one 2003-12-10 13:51:58 +00:00
sandbox Moved to sandbox. 2003-10-21 05:47:01 +00:00
scripts Fixed bug #856621, fixed the commented-out minimumLogPriority question. 2003-12-09 03:14:16 +00:00
src Added isCtcp. 2003-12-10 18:49:45 +00:00
test Added isCtcp. 2003-12-10 18:49:45 +00:00
tools headers conflicted with a command name, so it's now called trheader 2003-12-09 00:48:46 +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 Updated. 2003-10-13 05:35:40 +00:00
BUGS Added link to SF.net page 2003-03-25 23:21:42 +00:00
ChangeLog Todo.remove stuff 2003-12-10 13:53:02 +00:00
LICENSE Removed the Python-commented version of the LICENSE. 2003-10-23 07:18:42 +00:00
README Added note about included botscripts. 2003-11-22 17:10:00 +00:00
RELNOTES Updated. 2003-12-09 02:36:54 +00:00
setup.py Final changes in preparation for release. 2003-12-06 13:07:29 +00:00
TODO Updated. 2003-12-02 11:21:35 +00:00

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


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 (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 #supybot 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!

If you want, try out the included default botscripts.  Just be sure to
actually add an owner user for yourself with supybot-adduser.  (An
"owner user" is simply one with the owner capability).

WINDOWS USERS:
--------------
The wizards (supybot-wizard, supybot-newplugin, and
supybot-adduser) are all installed to your Python directory's
\Scripts.  What that *probably* means is that you'll run them like
this: C:\Python23\python C:\Python23\Scripts\supybot-wizard


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 PyLint.  It's even better than PyChecker.  A sample .pylintrc file
is included as tools/pylintrc.  Copy this to ~/.pylintrc and you'll be
able to check your code with the same stringent guidelines I've found
useful to check my code. (deja vu? :))

If you run the tests on Windows (or on a modem connection), be sure to 
exclude (test\test.py -e) test\test_Debian.py.