Commit 883e5723 authored by Praetorius, Simon's avatar Praetorius, Simon
Browse files

update the getting-started guide

parent d9789faa
......@@ -83,7 +83,12 @@ dune-common/bin/dunecontrol all
```
### Installing AMDiS
Assume that you have downloaded the AMDiS source into the directory `AMDIS_DIR`.
Assume that you have downloaded the AMDiS source into the directory `AMDIS_DIR`, i.e.,
```bash
git clone https://gitlab.mn.tu-dresden.de/amdis/amdis-core AMDIS_DIR
```
Then we can use the `dunecontrol` script from the Dune installation to configure
and build AMDiS as well. Therefore, we need to tell the `dunecontrol` script
where to find the Dune modules. This is dune by setting the `DUNE_CONTROL_PATH`
......@@ -98,6 +103,12 @@ DUNE_DIR/dune-common/bin/dunecontrol --current all
Again, the build parameters can be controlled by the `CMAKE_FLAGS` and `MAKE_FLAGS`
variables as above.
!!! note
If `AMDIS_DIR` is a sub-directory of `DUNE_DIR`, one could call `dunecontrol` from the
`DUNE_DIR` directly and in combination with the configuration of the other dune modules
as above. This allows to use just one call to configure and build all dune and AMDiS
modules and no need to set the `DUNE_CONTROL_PATH` variable.
## Starting a new Project
Creating a new project that uses AMDiS is fairly simple, by using the shipped
......
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