Limnoria

mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-19 17:09:27 +01:00

Go to file

Jeremy Fincher 9c17ec5c68 Documentation change.		2003-08-20 09:35:23 +00:00
docs	Needed to commit something, this will need to be changed.	2003-04-22 11:27:32 +00:00
examples	Initial revision	2003-03-12 06:26:59 +00:00
others	Shouldn't have removed it, since it has the hacks for telling me how many asserts it has done.	2003-08-17 06:18:33 +00:00
plugins	Documentation change.	2003-08-20 09:35:23 +00:00
sandbox	Removed friendly.py; it needs to be renamed Friendly.py and stuck in plugins/	2003-03-27 08:47:25 +00:00
scripts	Now plugins that are added to the conf file are removed from the list of available plugins.	2003-08-19 14:49:47 +00:00
src	Added function commaAndify to turn a list of strings into a proper English foo, bar, and baz string.	2003-08-20 09:24:57 +00:00
test	Added function commaAndify to turn a list of strings into a proper English foo, bar, and baz string.	2003-08-20 09:24:57 +00:00
tools	Made some changes to satisfy PyChecker.	2003-08-19 10:38:45 +00:00
.cvsignore	Initial revision	2003-03-12 06:26:59 +00:00
ACKS	Initial revision	2003-03-12 06:26:59 +00:00
BUGS	Added link to SF.net page	2003-03-25 23:21:42 +00:00
LICENSE	Initial revision	2003-03-12 06:26:59 +00:00
README	Added some information, removed others, etc.	2003-04-02 10:21:14 +00:00
TODO	Added a few more TODOs and a schedule.	2003-08-19 13:59:39 +00:00

README

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:
------
All commands should be run from the root directory, never from any
subdirectory such as conf/, log/, src/, or plugins/.

All you have to do to get a working bot is run scripts/setup.py and
answer the questions!