From b5bf97eca31b58aef95aa3d737f332a565c78bc4 Mon Sep 17 00:00:00 2001
From: schumaax <axel.schumacher@meisterfliesen.ws>
Date: Mon, 31 Jan 2022 14:18:58 +0100
Subject: [PATCH] [docu] improve course installation description

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
index 12839850..9bc5cc75 100644
--- a/README.md
+++ b/README.md
@@ -9,4 +9,29 @@ The material is organized as follows
 * __Slides__: click [here](./slides/README.md) to download the slides
 * __Links__: click [here](./links/README.md) to go to a list of useful links
 
+## Installation of the course
+
+To get started with the course, you have two options.
+Depending on whether you already have DuMu<sup>x</sup> installed or not, choose the one that fits your needs.
+
+### Install DuMu<sup>x</sup> together with the course
+
+The easiest way to install everything you need is to follow the steps in the [install script](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/-/blob/master/scripts/README.md).
+This will install everything for you to get directly started.
+
+### Install the course into your existing DuMu<sup>x</sup> project
+
+If you already have an installation of DuMu<sup>x</sup>,
+navigate to your common DuMu<sup>x</sup> root directory `cd yourInstallationFolder/dumux` and then run the following commands:
+
+
+```bash
+python3 dumux/bin/installexternal.py course
+./dune-common/bin/dunecontrol --opts=./dumux/cmake.opts all
+```
+
+This will download and then configure the course repository using `dunecontrol`.
+After this, you can start with the [exercises](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/-/tree/master/exercises).
+
+
 Last updated for: __DuMu<sup>x</sup> release 3.4 in June 2021__.
-- 
GitLab