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

Minor fixup of the docs/README.txt file

Browse source
This commit is contained in:
Griatch 2014-02-02 23:30:00 +01:00
parent 2306449ee1
commit dd491d4fde
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/README.txt
View file

@ -43,22 +43,24 @@ EVENNIA DOCUMENTATION
doxygen config.dox doxygen config.dox
This will create the auto-docs in a folder 'doxygen/html'. This will create the auto-docs in a folder 'html'.
- Start your web browser and point it to - Start your web browser and point it to
<evenniadir>/docs/doxygen/html/index.html <evenniadir>/docs/html/index.html
- If you prefer a pdf version for printing, use LaTeX by - If you prefer a pdf version for printing, use LaTeX by
activating the relevant section in config.dox. Run the activating the relevant section in config.dox. Run the
doxygen command again as above and a new folder 'latex' doxygen command again as above and a new folder 'latex'
will be created with the latex sources. With the latex will be created with the latex sources. You need the
processing system installed, then run LaTeX processing system installed, then enter the new
latex/ folder and run
make make
in the newly created folder to create the pdf. Be warned This will create the pdf. Be warned however that the pdf
however that the pdf docs are >340 pages long! docs are many hundreds of pages and the automatic formatting
of doxygen is not always succeeding.
- Doxyfile is allows for plenty of configuration to get the - Doxyfile is allows for plenty of configuration to get the
docs to look the way you want. You can also output to other docs to look the way you want. You can also output to other