]> https://gitweb.dealii.org/ - code-gallery.git/commitdiff
Reword README.md instructions
authorMatthias Maier <tamiko@43-1.org>
Thu, 8 Mar 2018 16:59:30 +0000 (10:59 -0600)
committerMatthias Maier <tamiko@43-1.org>
Thu, 8 Mar 2018 16:59:30 +0000 (10:59 -0600)
README.md

index 69e41edf3308e177ae8f7a7f2dfaf74a1f0c7d20..4b200bf9dbd0cc6ba3945c0a235ae370a277d3e3 100644 (file)
--- 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 `<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. 
+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.

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.