]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update readme. 8738/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 11 Sep 2019 21:32:15 +0000 (15:32 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 11 Sep 2019 21:32:15 +0000 (15:32 -0600)
doc/readme.html

index 5c54bb5a1c94f92004268d8bd3d626c3c9f054e7..3e82ba3aa8064e1909d42221a3f5c1d3eec3412f 100644 (file)
 
     <pre>
       cmake -DDEAL_II_COMPONENT_DOCUMENTATION=ON -DCMAKE_INSTALL_PREFIX=/path/install/dir ../deal.II
+      make documentation
+      make install
     </pre>
 
     <p>
+        As usual, you can pass <code>-jN</code> to <code>make</code>
+        in order to use more than one processor.
         For this to succeed, you will need <a href="http://www.perl.org/" target="_top">Perl 5.x</a>,
         <a href="http://www.doxygen.org/" target="_top">doxygen</a> and <code>dot</code> (which is part of the <a href="http://www.graphviz.org" target="_top">GraphViz</a> package) to be installed.
     </p>
         are then rendered natively by the browser. With <code>-DDEAL_II_DOXYGEN_USE_ONLINE_MATHJAX=OFF</code> CMake will try to find a local installation of MathJax scripts, otherwise the online version of the scripts will be used in the documentation.
     </p>
 
-    <p>
-        Upon calling <code>make</code> and <code>make install</code>, this will install both this readme, other installation instructions, as well as the
-        <a href="doxygen/deal.II/index.html" target="_top">manual that documents
-      all functions and classes</a> as well as the <a href="doxygen/deal.II/Tutorial.html" target="_top"> tutorial
-      of well-documented example programs</a> (the "steps").
-    </p>
-
     <p>
         <b>Note:</b> Generating this documentation can take a <i>really long
       time</i> &mdash; 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 <code>make</code>.

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.