From eeb4983d8eef268cb1e4d596b326feb7a6a14015 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Uwe=20K=C3=B6cher?= <koecher@hsu-hamburg.de>
Date: Fri, 30 Oct 2015 20:19:03 +0100
Subject: [PATCH] Update README.md

Extend the readme documentation for the newly available command line options.
---
 README.md | 52 +++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 43 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 6ed1598..d7b988d 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ Usage
 ----
 
 ### First Run
-Make sure, that you are in the downloaded folder of candi; e.g. after the download type
+Make sure, that you are in the downloaded folder of candi; e.g. after the download type in
 ```bash
  $> cd candi
 ```
@@ -50,21 +50,55 @@ You run the installer by
 ```
 Hit return and wait.
 
+#### Install deal.II on ubuntu 12.04, 14.xx, 15.xx :
+```bash
+  $> export CC=mpicc; export CXX=mpicxx; export FC=mpif90; export FF=mpif77
+  $> ./candi.sh
+```
+Hit return and wait.
+
 Adapting candi to your needs
 ----
 
-You can adapt several things to your personal needs, this includes the individual choice for
-* the DOWNLOAD folder (can be safely removed after installation),
-* the UNPACK folder of the downloaded packages (can be safely removed after installation),
-* the BUILD folder (can be safely removed after installation),
-* the INSTALLATION destination folder,
-* the NUMBER of build processes to use (Variable PROCS),
-and more options.
+### Command line options (CLO) for `./candi.sh [CLO]`
+
+You can combine the command line options given below.
+Read carefully the output of `./candi.sh` before running!
 
-Edit the file behind the softlink "candi.cfg", e.g.
+#### CLO: Prefix installation path: `[-p=<PATH>]`, `[--prefix=<PATH>]`
+```bash
+  $> ./candi.sh --prefix=Your/Prefix/Path
+```
+
+#### CLO: Using multiple build processes `[-j<Number>]`, `[--PROCS=<Number>]`
+```bash
+  $> ./candi.sh -j<Number>
+```
+* Remark: there is no whitespace character allowed between `-j` and the number `<Number>`.
+* Example: using 2 build processes `./candi.sh -j2` or `./candi.sh --PROCS=2`.
+* Be careful with that! You need to have enough system memory (e.g. at least 8GB for using 2 or more processes).
+
+### Configuration file options (CFO)
+
+Edit the configuration file behind the softlink "candi.cfg", e.g.
 ```bash
   $> gedit candi.cfg
 ```
+You can adapt several things to your personal needs here
+* the `DOWNLOAD_PATH` folder (can be safely removed after installation),
+* the `UNPACK_PATH` folder of the downloaded packages (can be safely removed after installation),
+* the `BUILD_PATH` folder (can be safely removed after installation),
+* the `INSTALL_PATH` destination folder,
+and more options.
+
+Remarks. Please set the variables
+* `PREFIX_PATH`
+* `PROCS`
+via the command line options (CLO) as described above.
+
+Note: setting the denoted variables in the configuration file will fix them,
+and they cannot be overwritten by command line options anymore.
+
 
 Switching candi to other Projects (e.g. FEniCS)
 ----
-- 
2.39.5