From: Matthias Maier Date: Thu, 8 Mar 2018 16:59:30 +0000 (-0600) Subject: Reword README.md instructions X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4b1efcea87579c78ab14583e1229013e284af69f;p=code-gallery.git Reword README.md instructions --- diff --git a/README.md b/README.md index 69e41ed..4b200bf 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ # code-gallery -The [code gallery](https://dealii.org/developer/doxygen/deal.II/CodeGallery.html) is a collection of codes based on -[deal.II](https://www.dealii.org) contributed by `deal.II` -users. These codes typically solve problems more complicated than -those in the deal.II tutorial. Their intention is to solve actual -problems, rather than demonstrate particular aspects of deal.II. -The code gallery is, however, cross linked from the +The [code gallery](https://dealii.org/developer/doxygen/deal.II/CodeGallery.html) +is a collection of codes based on [deal.II](https://www.dealii.org) +contributed by `deal.II` users. These codes typically solve problems more +complicated than those in the deal.II tutorial. Their intention is to solve +actual problems, rather than demonstrate particular aspects of deal.II. The +code gallery is, however, cross linked from the [set of tutorials](https://dealii.org/developer/doxygen/deal.II/Tutorial.html#TutorialConnectionGraph). ### 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. +To build the doxygen documentation, simply check out the code gallery git +repository into the main deal.II source directory (parallel to the +`examples`, or `doc` 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.