diff --git a/README.md b/README.md index 28c43745cf5e8937e3206bac685939fc02b016c3..731965303a7048a2fb8c249583db501b74072a13 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ This is OPAL >= 1.9.9. Be aware of the fact that the documentation is not -anymore a seperate project. The documentation is in this repository in the -directory 'doc' (https://gitlab.psi.ch/OPAL/src/tree/master/doc). On machines +anymore a seperate project. + +The documentation is in this repository in the +directory 'doc' (https://gitlab.psi.ch/OPAL/src/tree/master/doc). + +On machines with LaTeX the User's Reference Manual can be built in the same directory as the code by configuring cmake using -DENABLE_DOCUMENTATION=1 to enable the compilation. + The manual can then be built by calling 'make doc'. If you want to compile the manual every time you compile the code then set -DEXCLUDE_DOC_FROM_ALL=0 . \ No newline at end of file