Limnoria

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

Go to file

Jeremy Fincher 6d40bb475e Karma works now.		2003-08-12 19:38: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	Removed since the bug was fixed in 2.3.	2003-08-10 11:23:49 +00:00
plugins	Karma works now.	2003-08-12 19:38: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	Moved file writing to later in the run.	2003-04-16 07:13:29 +00:00
src	Changed nick/user/host of server hostmask to be the hostmask itself. Also disabled _ircmsg import for the time being.	2003-08-12 19:12:44 +00:00
test	Nuked ircutils.nick. Good riddance.	2003-08-12 19:12:12 +00:00
tools	Added vim:set ... : strings to source in order to keep file formatting	2003-03-24 08:41:19 +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

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!