Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Just adding a few lines of README for those not aware of what to do about the docs/doxygen folder.

Browse source
This commit is contained in:
Griatch 2009-04-26 07:55:25 +00:00
parent a9dbac8aae
commit 54e2564a9f
3 changed files with 23 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/README Normal file
View file

@ -0,0 +1,14 @@
* Evennia documentation
To build the auto-documentation (overview of all the sources, with comments), read the
instructions in ./doxygen.
The most updated 'manual' is currently the online wiki, at
http://code.google.com/p/evennia/wiki/Index?tm=6
You can ask for help from the evennia community here:
http://groups.google.com/group/evennia

2
docs/doxygen/Doxyfile
View file

@ -272,4 +272,4 @@ DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
SEARCHENGINE = YES

8
docs/doxygen/README Normal file
View file

@ -0,0 +1,8 @@
To create the developer auto-docs, install doxygen (it's available for most platforms here:
http://www.stack.nl/~dimitri/doxygen/ ), and run
> doxygen Doxyfile
in this directory. This will create the auto-docs in ./output/html. To read, point your web browser to
evennia/docs/doxygen/output/html/index.html. If you prefer a pdf / paper hardcopy, install the LaTeX
system and activate the relevant section in Doxyfile.