Go to file
Jeremy Fincher 4a706a1aae Updated. 2004-02-11 07:17:11 +00:00
debian Use dh_python as suggested by jamessan. Also make architecture "all". 2004-02-05 04:35:46 +00:00
docs some :tw=70 gq fun and fixed a grammar mistake wrt when you should edit the 2004-02-08 22:48:07 +00:00
examples Updated examples. 2003-11-15 08:23:11 +00:00
others First functional commit; units.dat placed in file & read with StringIO. 2004-01-25 07:04:45 +00:00
plugins Fixed supybot.channels to use an IrcSet instead of a list. 2004-02-11 06:27:35 +00:00
sandbox Moved to sandbox. 2003-10-21 05:47:01 +00:00
scripts Moved enablePipeSyntax to advanced and cleaned up some style stuff (the rest will wait until after the release is out). 2004-02-11 06:21:21 +00:00
src Fixed removecapability bug. 2004-02-11 06:59:44 +00:00
test Fixed G-LiTe's bug with -l. 2004-02-11 06:57:35 +00:00
tools Small buggeh. 2004-02-09 23:54:56 +00:00
.cvsignore Initial revision 2003-03-12 06:26:59 +00:00
ACKS Removed people that are in DEVS. 2004-02-04 07:21:06 +00:00
BUGS Added bug #836270 to the BUGS list. 2004-01-12 19:06:00 +00:00
ChangeLog Updated. 2004-02-02 08:35:38 +00:00
DEVS Added some info about me since jemfinch decided to remove me from the ACKS 2004-02-04 21:59:42 +00:00
LICENSE Updated. 2004-01-21 17:56:06 +00:00
README Updated a whole lot of documentation. 2004-01-26 03:51:02 +00:00
RELNOTES Updated. 2004-02-11 07:17:11 +00:00
TODO Slight stylistic updates. 2004-01-30 19:27:02 +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 Made to remove the former installation to stop any confusion from occurring. 2004-02-11 06:47:55 +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.