Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added docs/ dir to readme file..

Browse source
This commit is contained in:
Griatch 2011-09-13 11:49:57 +02:00
parent ffeb1494cb
commit f523ce686a
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README
View file

@ -102,6 +102,7 @@ appreciate all help! Visit either of the following resources:
Directory structure Directory structure
------------------- -------------------
evennia evennia
|
|_______src |_______src
| |___(engine-related dirs) | |___(engine-related dirs)
| |
@ -110,6 +111,8 @@ evennia
| |___(game-related dirs) | |___(game-related dirs)
| |
|_______contrib |_______contrib
|
|_______docs
The two main directories you will spend most of your time in The two main directories you will spend most of your time in
are src/ and game/ (probably mostly game/). are src/ and game/ (probably mostly game/).
@ -135,6 +138,10 @@ but deemed to be too game-specific to be part of the server itself.
Modules in contrib are not used unless you yourself decide to import Modules in contrib are not used unless you yourself decide to import
and use them. and use them.
docs/ contain offline versions of the documentation, you can use
python-sphinx to convert the raw data to nice-looking output for
printing etc. The online wiki is otherwise first to be updated.
With this little first orientation, you should head into the online With this little first orientation, you should head into the online
Evennia wiki documentation to get going with the codebase. Evennia wiki documentation to get going with the codebase.