]> https://gitweb.dealii.org/ - code-gallery.git/commitdiff
Update README 25/head
authorJean-Paul Pelteret <jppelteret@gmail.com>
Wed, 1 Mar 2017 15:22:51 +0000 (16:22 +0100)
committerGitHub <noreply@github.com>
Wed, 1 Mar 2017 15:22:51 +0000 (16:22 +0100)
Add instructions on how to build the doxygen documentation

README.md

index aeacb1a63e218e3829d3e129a6e9e79a0801b31a..d63ea5b2fe9f4f09a4b4f51373036a7b75822c21 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,7 @@
 # code-gallery
-A collection of codes based on deal.II contributed by deal.II users
+A collection of codes based on [deal.II](https://www.dealii.org) contributed by `deal.II` users
+
+### Building the documentation
+
+To build the doxygen documentation, check out the code gallery git repository in a directory parallel to the `<path/to/deal.II>/examples/` directory, and then build the `deal.II` documentation as [described in the readme](https://www.dealii.org/developer/readme.html#documentation). 
+It will pick up the code gallery and create joint documentation for the tutorial and the code gallery. 

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.