]> https://gitweb.dealii.org/ - code-gallery.git/commitdiff
Minor updates to the README. 175/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 5 Mar 2024 22:22:38 +0000 (15:22 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 5 Mar 2024 22:22:38 +0000 (15:22 -0700)
Really just grammar and mark-up issues.

README.md

index 167189fc8162851a49ce7afcdbc7819075edf7df..0a3d8ead9031ff45367bc50fa8fd3779ad367e6c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # 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
+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
@@ -11,7 +11,7 @@ code gallery is, however, cross linked from the
 
 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
+`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
@@ -19,10 +19,10 @@ tutorial and the code gallery.
 
 ### Maintainance of contributed codes
 
-The examples in the code-gallery of periodically adjusted so that they
-maintain compatibility with a "recent" version of the `deal.II`. This means
-that their implementation may be modified slightly in the process, breaking
-compatibility with older versions of `deal.II`. Older version of each
+The examples in the code-gallery are periodically adjusted so that they
+maintain compatibility with recent versions of deal.II. This means
+that their implementation may be modified slightly in the process, perhaps breaking
+compatibility with older versions of deal.II. Older version of each
 contributed code may be attained by checking out the appropriate git commit
 of the code-gallery repository.
 

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.