Go to file
Jeremy Fincher 86524fa148 Added revision command for finding out the revision of supybot's files. 2003-11-25 09:32:18 +00:00
docs Fixed one s/needed/required/ in EXAMPLE and updated example.sgml to match the 2003-11-24 20:48:01 +00:00
examples Updated examples. 2003-11-15 08:23:11 +00:00
others Multiple bugs that couldn't be tested while the dict.org server was down have now been tested, found, and eradicated. 2003-11-13 17:11:52 +00:00
plugins Allowed escaping of colons in supyfact files. Didn't allow escaping of backslashes, yet, but that's less a worry, I think. 2003-11-25 09:08:06 +00:00
sandbox Moved to sandbox. 2003-10-21 05:47:01 +00:00
scripts Fixed logic bug in prefixchar questions. 2003-11-22 17:08:39 +00:00
src Added revision command for finding out the revision of supybot's files. 2003-11-25 09:32:18 +00:00
test Added revision command for finding out the revision of supybot's files. 2003-11-25 09:32:18 +00:00
tools Yay! Full navbar on all pages 2003-11-21 04:50:28 +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 Added revision command for finding out the revision of supybot's files. 2003-11-25 09:32:18 +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-11-22 05:00:49 +00:00
TODO Updated. 2003-11-22 04:45:10 +00:00
__init__.py Initial checkin of the distutils stuff. 2003-09-24 07:19:54 +00:00
setup.py Updated to the new version in preparation for the next release. 2003-11-12 01:34:24 +00:00

README

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.