Added some information, removed others, etc.

This commit is contained in:
Jeremy Fincher 2003-04-02 10:21:14 +00:00
parent 6385806048
commit 2b2f9356e0

21
README
View File

@ -3,23 +3,22 @@ EVERYONE:
Read LICENSE. It's a 2-clause BSD license, but you should read it anyway. Read LICENSE. It's a 2-clause BSD license, but you should read it anyway.
PROGRAMMERS: DEVELOPERS:
------------ ------------
Read OVERVIEW to see what the modules are used for. Read EXAMPLE to see some 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 examples of callbacks and command written for the bot. Read STYLE if you ever
wish to contribute. wish to contribute.
All contributions need to assign the copyright to Jeremiah Fincher for Use PyChecker. Believe me, it makes things better. A sample
licensing and modification purposes. I'll probably change the modules to fit .pycheckrc file is included as tools/pycheckrc. Copy this to your
STYLE if they don't already fit. (Of course, that doesn't mean 'all ~/.pycheckrc and you'll be able to check your code with the same
modifications'; only if you want your code to be included in the *standard stringent guidelines I've found useful to check my code.
distribution* of Supybot do you need to assign to me the copyright. If you
don't mind distributing your modifications or additions elsewhere, by all means
keep the copyright.)
Use PyChecker. Believe me, it makes things better.
USERS: USERS:
------ ------
<to be inserted later, when scripts/setup.py is done> 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!