From 554e893bdefe8b98be9fce5296ca0db5272698cc Mon Sep 17 00:00:00 2001
From: Fabian Castelli <fabian.castelli@kit.edu>
Date: Mon, 7 Jun 2021 12:31:54 +0200
Subject: [PATCH] Updated readme file

---
 README.md | 23 +++++++++++++++--------
 1 file changed, 15 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 46c1b8a..11e6e6b 100644
--- a/README.md
+++ b/README.md
@@ -25,13 +25,13 @@ Follow the instructions on the screen
 
 ### Examples
 
-#### Install deal.II on RHEL 7, CentOS 7 or Fedora 26,27,28:
+#### Install deal.II on RHEL 7, CentOS 7 or Fedora 26, 27, 28:
 ```bash
   module load mpi/openmpi-`uname -i`
   ./candi.sh
 ```
 
-#### Install deal.II on ubuntu 12.04, 14.xx, 15.xx, 16.xx, 17.xx:
+#### Install deal.II on ubuntu 18.04, 20.xx:
 ```bash
   ./candi.sh
 ```
@@ -40,13 +40,15 @@ Follow the instructions on the screen
 ```bash
   ./candi.sh
 ```
+Note: macOS support is currently experimental.
 
 #### Install deal.II on Windows 10 (1709):
 Since the Creators Update in fall 2017 (Windows 10 (1709)) the
 Windows Subsystem for Linux (WSL) is an official part.
 
-For an detailed instruction how to install WSL and a recent Ubuntu distribution
-on Windows 10 you can follow the Microsoft Documentation.
+For a detailed instruction how to install WSL, the new WSL 2 and a recent
+ubuntu distribution on Windows 10 you can follow the
+[Microsoft Documentation](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
 
 Within the ubuntu terminal application clone this repository and run candi
 
@@ -91,13 +93,16 @@ Advanced Configuration
 You can get a list of all command line options by running
 ```bash
   ./candi.sh -h
+  ./candi.sh --help
 ```
 
 You can combine the command line options given below.
 
-#### Prefix path: ``[-p=<PATH>]``, ``[--prefix=<PATH>]``
+#### Prefix path: ``[-p <path>]``, ``[-p=<path>]``, ``[--prefix=<path>]``
 ```bash
-  ./candi.sh --prefix=Your/Prefix/Path
+  ./candi.sh -p "/path/to/install/dir"
+  ./candi.sh -p="/path/to/install/dir"
+  ./candi.sh --prefix="/path/to/install/dir"
 ```
 
 #### Multiple build processes: ``[-j<N>]``, ``[-j <N>]``, ``[--jobs=<N>]``
@@ -114,6 +119,7 @@ You can combine the command line options given below.
 #### Specific platform: ``[-pf=<platform>]``, ``[--platform=<platform>]``
 ```bash
   ./candi.sh -pf=./deal.II-toolchain/platforms/...
+  ./candi.sh --platform=./deal.II-toolchain/platforms/...
 ```
 
 If your platform is not detected automatically you can specify it with this
@@ -124,6 +130,8 @@ see [deal.II-toolchain/platforms](deal.II-toolchain/platforms).
 #### User interaction: ``[-y]``, ``[--yes]``, ``[--assume-yes]``
 ```bash
   ./candi.sh -y
+  ./candi.sh --yes
+  ./candi.sh --assume-yes
 ```
 
 With this option you skip the user interaction. This might be useful if you
@@ -161,9 +169,8 @@ There are several options within the configuration file, for example:
   NATIVE_OPTIMIZATIONS={ON|OFF}
 ```
 
-* Enable the build of the deal.II examples and documentation
+* Enable the build of the deal.II examples
 ```bash
-  BUILD_DOCUMENTATION={ON|OFF}
   BUILD_EXAMPLES={ON|OFF}
 ```
 
-- 
2.39.5