From f1db645d419c3d4d6ce7aa32fd0390d9c3488083 Mon Sep 17 00:00:00 2001 From: Javier Moran Rua Date: Tue, 12 Jan 2010 13:43:40 +0100 Subject: [PATCH] ItEr43S07DocumentacionFormacionItEr42S07: INSTALL file explaining how to compile documentation. --- INSTALL | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/INSTALL b/INSTALL index 6b28dec1a..1157c1bdb 100644 --- a/INSTALL +++ b/INSTALL @@ -104,3 +104,24 @@ the selected page. [1] http://cutycapt.sourceforge.net/ [2] http://www.xfree86.org/4.0.1/Xvfb.1.html + +User Documentation +------------------ + +User documentation is done in *Reestructured Text*. It is necessary to have installed +the following packages: + + * automake package in order to be able to execute "make". + * "python-docutils" package version 0.4 or higher. + * "texlive-latex-base" package in order to have "pdflatex" available. + +Compilation +----------- + +The compilation is included in Maven build. If you execute "mvn install" documentation is generated. + +* For manual compilation, inside "doc/src/es", "doc/src/gl" or "doc/src/es" directories: + make html + make pdf + +* Output is created in "doc/src/es/html" and "/doc/src/es/pdf" directories.