From dd491d4fde1445f2f69b690ee6a8e9cf9547a5e8 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 2 Feb 2014 23:30:00 +0100 Subject: [PATCH] Minor fixup of the docs/README.txt file --- docs/README.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/README.txt b/docs/README.txt index 9f4aaf4466..cc09c85635 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -43,22 +43,24 @@ EVENNIA DOCUMENTATION 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 - /docs/doxygen/html/index.html + /docs/html/index.html - If you prefer a pdf version for printing, use LaTeX by activating the relevant section in config.dox. Run the doxygen command again as above and a new folder 'latex' - will be created with the latex sources. With the latex - processing system installed, then run + will be created with the latex sources. You need the + LaTeX processing system installed, then enter the new + latex/ folder and run make - in the newly created folder to create the pdf. Be warned - however that the pdf docs are >340 pages long! + This will create the pdf. Be warned however that the pdf + 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 docs to look the way you want. You can also output to other