Go to file
James Vega a8d2e35fb1 Initial pass at Sphinx documentation.
Rename all existing documentation files to *.rst.
Fix up some of the formatting to work better as reStructuredText.
Add Sphinx's output directories to gitignore.
Signed-off-by: James Vega <jamessan@users.sourceforge.net>
2010-08-24 18:24:52 -04:00
docs Initial pass at Sphinx documentation. 2010-08-24 18:24:52 -04:00
plugins Include String plugin for Utilities' tests. 2010-07-11 11:04:33 -04:00
sandbox release.py: Remove the archives after uploading to Sourceforge 2009-05-25 13:50:05 -04:00
scripts supybot: Remove extraneous sys.stdin.close() 2010-06-20 09:40:57 -04:00
src Ensure channel-specific reply.whenNotAddressed works. 2010-07-26 19:48:37 -04:00
test Until we can safely load Karma, this test is staying commented out. 2009-11-25 09:17:52 -06:00
.gitattributes Add export-ignore gitattributes for test/, sandbox/, and .git* 2009-03-16 23:43:28 -04:00
.gitignore Initial pass at Sphinx documentation. 2010-08-24 18:24:52 -04:00
ACKS Updated to be STX as well as ordered chronologically. 2005-01-19 23:39:52 +00:00
ChangeLog Update ChangeLog and RELNOTES for 0.83.4.1 2009-05-25 13:15:44 -04:00
INSTALL Bump the minimum supported Python version to 2.4. 2009-10-23 19:35:24 -04:00
LICENSE LICENSE: Update Copyright date range 2009-05-07 22:41:39 -04:00
README Use '2x' to reference Python version in README. 2009-10-23 20:07:48 -04:00
RELNOTES Bump the minimum supported Python version to 2.4. 2009-10-23 19:35:24 -04:00
setup.py Remove supybot-plugin-package from the set of installed files. 2009-10-25 09:20:45 -04:00

README

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

USERS:
------
If you're upgrading, read RELNOTES.  There is also much documentation
at http://supybot.com/ for your perusal.  Please read it; we took the
time to write it, you should take the time to read it.

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:\Python2x\python C:\Python2x\Scripts\supybot-wizard

DEVELOPERS:
-----------
We likewise have tons of developer documentation at
http://supybot.com/ for your learning adventures.  Have fun :)