From: Wolfgang Bangerth Date: Wed, 11 Sep 2019 21:32:15 +0000 (-0600) Subject: Update readme. X-Git-Tag: v9.2.0-rc1~1115^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F8738%2Fhead;p=dealii.git Update readme. --- diff --git a/doc/readme.html b/doc/readme.html index 5c54bb5a1c..3e82ba3aa8 100644 --- a/doc/readme.html +++ b/doc/readme.html @@ -255,9 +255,13 @@ 
       cmake -DDEAL_II_COMPONENT_DOCUMENTATION=ON -DCMAKE_INSTALL_PREFIX=/path/install/dir ../deal.II
+      make documentation
+      make install

+ As usual, you can pass -jN to make + in order to use more than one processor. For this to succeed, you will need Perl 5.x, doxygen and dot (which is part of the GraphViz package) to be installed.

@@ -270,13 +274,6 @@ are then rendered natively by the browser. With -DDEAL_II_DOXYGEN_USE_ONLINE_MATHJAX=OFF CMake will try to find a local installation of MathJax scripts, otherwise the online version of the scripts will be used in the documentation.

-

- Upon calling make and make install, this will install both this readme, other installation instructions, as well as the - manual that documents - all functions and classes as well as the tutorial - of well-documented example programs (the "steps"). -

-

Note: Generating this documentation can take a really long time — running doxygen through our hundreds of thousands of lines of code can take 15-20 minutes even on a fast machine during which you will not get any output from make.