]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Mention how to install the documentation in the readme
authormaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 7 Nov 2012 15:00:25 +0000 (15:00 +0000)
committermaier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 7 Nov 2012 15:00:25 +0000 (15:00 +0000)
git-svn-id: https://svn.dealii.org/branches/branch_cmake@27461 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/TODO.CMAKE
deal.II/doc/readme.html

index d0e93d1638f74db137644da491740e65332d197b..f702c1452e860d5f930acba6cc47ee6e1134c7a4 100644 (file)
@@ -6,8 +6,6 @@ Major:
     (WB: actually, no -- this is a change that should happen on
      mainline once we have migrated the whole wiki)
 
-  - The ReadME should mention how to install the documentation
-
   - Write a page on how to use deal.II in external CMake projects.
     (doc/development/toc.html already links to it)
     (A more detailed copy of what is already standing in cmake.html)
index 001e1d130fda8968942747776e00202ea2ae5b8c..3fec4fda7e3fd60d3e10e85aa8c40916ba43d9ea 100644 (file)
          specifically do not want to use it, then
          pass <code>-DDEAL_II_WITH_MPI=OFF</code>.
        </p>
+
+      <li>
+        <p>
+          To build and install the documentation, specify
+          <code>-DDEAL_II_COMPONENT_DOCUMENTATION=ON</code>
+          on the command line.  For generating the documentation <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) have to be installed.
+
+      <li>
+        <p>
+          If you wish to install projects residing under
+          <code>contrib/</code> such as ParameterGUI,
+          specify <code>-DDEAL_II_COMPONENT_CONTRIB=ON</code>.
+          Beware of the fact that parameterGUI needs
+          development packages for Qt.
+
     </ul>
 
 

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.