Limnoria

mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-23 19:22:45 +01:00

Go to file

Jeremy Fincher 5d31e2a2d6 Moved to tools.		2003-09-24 07:29:49 +00:00
docs	Added documentation for the interface to the IrcMsg class.	2003-09-22 09:34:18 +00:00
examples	Updated EXAMPLE, finally :)	2003-09-14 03:33:02 +00:00
others	Initial checkin of the distutils stuff.	2003-09-24 07:19:54 +00:00
plugins	Removed the old sys.path-munging code now that we're disutil'ed.	2003-09-24 07:28:25 +00:00
sandbox	Removed, old files.	2003-09-24 05:13:08 +00:00
scripts	Moved to tools.	2003-09-24 07:29:49 +00:00
src	Removed the old sys.path-munging code now that we're disutil'ed.	2003-09-24 07:28:25 +00:00
test	Removed the old sys.path-munging code now that we're disutil'ed.	2003-09-24 07:28:25 +00:00
tools	Removed, old file.	2003-09-24 05:11:24 +00:00
__init__.py	Initial checkin of the distutils stuff.	2003-09-24 07:19:54 +00:00
.cvsignore	Initial revision	2003-03-12 06:26:59 +00:00
ACKS	Added some stuff, though it still needs much more.	2003-09-17 07:26:43 +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
setup.py	Initial checkin of the distutils stuff.	2003-09-24 07:19:54 +00:00
TODO	Updated.	2003-09-24 06:00:36 +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!