From: Jean-Paul Pelteret Date: Wed, 1 Mar 2017 15:22:51 +0000 (+0100) Subject: Update README X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=871b4d0f90f7f77d2cb061e0356362dc4711747a;p=code-gallery.git Update README Add instructions on how to build the doxygen documentation --- diff --git a/README.md b/README.md index aeacb1a..d63ea5b 100644 --- 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 `/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.