Go to file
Jeremy Fincher d0e5d72d00 Updated. 2004-07-24 05:32:45 +00:00
debian Added a build-depends on python-dev, which is required for distutils. 2004-04-11 23:48:34 +00:00
docs Fixed TODO 124. 2004-07-20 06:03:17 +00:00
examples yay! no more stray whitespace 2004-07-21 19:36:35 +00:00
others w00, less path mungingEXCLAIMEXCLAIM 2004-07-24 05:18:26 +00:00
plugins w00, less path mungingEXCLAIMEXCLAIM 2004-07-24 05:18:26 +00:00
sandbox w00, less path mungingEXCLAIMEXCLAIM 2004-07-24 05:18:26 +00:00
scripts w00, less path mungingEXCLAIMEXCLAIM 2004-07-24 05:18:26 +00:00
src w00, less path mungingEXCLAIMEXCLAIM 2004-07-24 05:18:26 +00:00
test w00, less path mungingEXCLAIMEXCLAIM 2004-07-24 05:18:26 +00:00
tools yay! no more stray whitespace 2004-07-21 19:36:35 +00:00
.cvsignore Initial revision 2003-03-12 06:26:59 +00:00
ACKS Updated. 2004-04-09 17:13:49 +00:00
BUGS Added bug #836270 to the BUGS list. 2004-01-12 19:06:00 +00:00
ChangeLog Updated. 2004-07-23 06:58:08 +00:00
DEVS kmj is right. Writing in third person is balls. :) 2004-04-16 08:56:55 +00:00
LICENSE Updated. 2004-04-09 17:13:49 +00:00
README Updated a whole lot of documentation. 2004-01-26 03:51:02 +00:00
RELNOTES Updated. 2004-07-24 05:32:45 +00:00
TODO Updated. 2004-07-19 22:05:32 +00:00
__init__.py Eh, those things didn't need to be where they were. 2004-02-02 17:19:38 +00:00
setup.py w00, less path mungingEXCLAIMEXCLAIM 2004-07-24 05:18:26 +00:00

README

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


USERS:
------
Read docs/GETTING_STARTED for an introduction to the bot.  Read
docs/CAPABILITIES to see how to use capabilities more to your
benefit. 

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, 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 commands written for the bot.
Read INTEFACES to see what kinds of objects you'll be dealing with.
Read STYLE if you wish to contribute; all contributed code must meet
the guidelines set forth there..

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? :))

Be sure to run "test/test.py --help" to see what options are available
to you when testing.  Windows users in particular should be sure to
exclude test_Debian.py and test_Unix.py.