Skip to content

Commit

Permalink
Merge pull request #175 from bangerth/readme
Browse files Browse the repository at this point in the history
Minor updates to the README.
  • Loading branch information
tamiko authored Mar 6, 2024
2 parents 44499d0 + 9790b90 commit 0b70d37
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -11,18 +11,18 @@ 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
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.

0 comments on commit 0b70d37

Please sign in to comment.