Commit 02530ef8 authored by Praetorius, Simon's avatar Praetorius, Simon
Browse files

update the README file

parent dc2965fd
......@@ -3,10 +3,15 @@ AMDiS
The *Adaptive Multi-Dimensional Simulation Toolbox* (AMDiS) is implemented as a
discretization module on top of the Dune framework.
Documentation
=============
See the online documentation [amdis.readthedocs.io](https://amdis.readthedocs.io) that is
generated from the Markdown files in the `docs/` directory.
Installation
============
We provide a *cmake*-based configuration and use the `dunecontrol` build system.
Simply run
We provide a *cmake*-based configuration and use the `dunecontrol` build system of the Dune
framework. Simply run
```
dunecontrol --current all
......@@ -43,7 +48,8 @@ Additionally the following optional libraries can be used:
And a compiler that supports the C++14 standard, e.g. g++ >= 5.0 and clang >= 3.6, and cmake >= 3.1.
By default, the `dune-istl` linear-algebra backend is used. To choose one of `ISTL`, `MTL`, `PETSC`, or `EIGEN`, you can specify the cmake parameter `-DBACKEND=[ISTL,MTL,PETSC,EIGEN]`.
By default, the `dune-istl` linear-algebra backend is used. To choose one of `ISTL`, `MTL`,
`PETSC`, or `EIGEN`, you can specify the cmake parameter `-DBACKEND=[ISTL,MTL,PETSC,EIGEN]`.
If, for example, your MTL4 installation is not found by default, you have to specify the path,
where the file `MTLConfig.cmake` is found, here called `MTL_ROOT`. Then simply use
......
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