mirror of https://github.com/Mikaela/Limnoria.git
39 lines
1.4 KiB
Plaintext
39 lines
1.4 KiB
Plaintext
EVERYONE:
|
|
---------
|
|
Read LICENSE. It's a 2-clause BSD license, but you should read it anyway.
|
|
|
|
|
|
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.
|
|
|
|
|
|
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 #sourcereview 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!
|