Commit 6e73030d authored by Praetorius, Simon's avatar Praetorius, Simon
Browse files

Update README.md. Added installation instructions.

parent 816416d3
......@@ -65,8 +65,26 @@ for (auto const& e : edges(gv)) {
## Installation
We provide a *cmake*-based configuration. See also the `INSTALL.md` file in the
source directory.
We provide a *cmake*-based configuration and use the `dunecontrol` build system.
Simply run
```
dunecontrol --current all
cmake --build build-cmake --target examples
```
to build all the example problems. The `dunecontrol` script searches for the required
(and suggested) dune modules this library depends on. These include:
- dune-common
- dune-geometry
- dune-grid
- dune-localfunctions
- dune-functions
(See the file `dune.module` for an up-to-date list of dependencies). The dune modules
can be obtained from https://gitlab.dune-project.org and need to be found in a
subdirectory of `DUNE_CONTROL_PATH`. See als https://dune-project.org/doc/installation
for details about the installation of dune modules.
## Documentation
......@@ -74,5 +92,5 @@ Currently only a *doxygen*-based documentation of the source files is available.
Generate a html version by
```
doxygen doc/Doxyfile
cmake --build build-cmake --target documentation
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment