Blame view

DOCUMENTATION/README.md 961 Bytes
886c558b   Steve Greedy   SACAMOS Public Re...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
The documentation is written using LaTeX. The documentation consists
of a theory manual, a user guide and validaton test case documentation.

the pdf documentation can be built (and cleaned) from this directory with the following commands:

make                     : make SACAMOS_UserGuide.pdf and SACAMOS_TheoryManual.pdf
make install             : make SACAMOS_UserGuide.pdf and SAMAMOS_TheoryManual.pdf and move to the top level
make user_guide          : make SACAMOS_UserGuide.pdf
make theory_manual       : make SACAMOS_TheoryManual.pdf
make clean               : clean all LaTeX files
make clean_theory_manual : clean theory manual LaTeX files
make clean_user_guide    : clean user guide LaTeX files
make clean_all           : clean all LaTeX files and image files

The common class file and pdfs for NLR and UoN logos are in the directory

COMMON_LATEX_FILES

and all the required tex and image files for the documents in their
respective directories.