1
0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-20 00:52:48 +01:00
Limnoria/README

43 lines
1.6 KiB
Plaintext
Raw Normal View History

2003-03-12 07:26:59 +01:00
EVERYONE:
---------
Read LICENSE. It's a 2-clause BSD license, but you should read it anyway.
USERS:
------
2004-01-26 04:51:02 +01:00
Read docs/GETTING_STARTED for an introduction to the bot. Read
docs/CAPABILITIES to see how to use capabilities more to your
benefit.
2003-09-29 08:51:12 +02:00
If you have any trouble, feel free to swing by #supybot on
2004-01-26 04:51:02 +01:00
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
2003-09-29 08:51:12 +02:00
wherever we can. And by all means, if you find anything hard to
2004-01-26 04:51:02 +01:00
understand or think you know of a better way to do something,
*please* post it on Sourceforge.net so we can improve the bot!
2003-10-11 13:15:14 +02:00
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
2003-10-11 13:15:14 +02:00
DEVELOPERS:
-----------
2004-01-26 04:51:02 +01:00
Read OVERVIEW to see what the modules are used for. Read EXAMPLE to
see some examples of callbacks and commands written for the bot.
2004-08-11 06:59:44 +02:00
Read INTERFACES to see what kinds of objects you'll be dealing with.
2004-01-26 04:51:02 +01:00
Read STYLE if you wish to contribute; all contributed code must meet
the guidelines set forth there..
2003-10-11 13:15:14 +02:00
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? :))
2004-01-26 04:51:02 +01:00
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.