From f523ce686aa79db9def47c28f3a142afb1265e50 Mon Sep 17 00:00:00 2001 From: Griatch Date: Tue, 13 Sep 2011 11:49:57 +0200 Subject: [PATCH] added docs/ dir to readme file.. --- README | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README b/README index 9f2dbef13e..0364ede3bc 100644 --- a/README +++ b/README @@ -102,6 +102,7 @@ appreciate all help! Visit either of the following resources: Directory structure ------------------- evennia + | |_______src | |___(engine-related dirs) | @@ -110,6 +111,8 @@ evennia | |___(game-related dirs) | |_______contrib + | + |_______docs The two main directories you will spend most of your time in 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 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 Evennia wiki documentation to get going with the codebase.