Go to file
2003-10-11 20:52:35 +00:00
docs Removed star imports. 2003-10-05 13:02:56 +00:00
examples Removed, since they're practically useless. No one's going to write their own conf files by hand. 2003-10-05 20:43:10 +00:00
others Updated the Amazon Web Services URL 2003-09-30 19:00:53 +00:00
plugins Added a urlsnarfer and the appropriate tests 2003-10-11 20:52:35 +00:00
sandbox Baseplugins -> plugins update. 2003-10-11 12:48:30 +00:00
scripts Stupid me forgot to import sets. 2003-10-11 16:22:07 +00:00
src Fixed handling of secure flag by IrcUser.setAuth. 2003-10-11 10:20:15 +00:00
test Added a urlsnarfer and the appropriate tests 2003-10-11 20:52:35 +00:00
tools Updates. 2003-10-05 13:21:29 +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
ChangeLog Updated. 2003-10-11 12:48:48 +00:00
LICENSE Initial revision 2003-03-12 06:26:59 +00:00
README Changed a slash to a backslash. 2003-10-11 16:20:30 +00:00
setup.py Updated version. 2003-10-10 23:18:01 +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.


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


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


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.

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.