From: Timo Heister <timo.heister@gmail.com>
Date: Fri, 22 Apr 2016 12:54:33 +0000 (+0100)
Subject: update readme
X-Git-Tag: v0.8.5~40^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7219795351e7c02fd792f311697ce54bcbb99bd9;p=candi.git

update readme
---

diff --git a/README.md b/README.md
index b975656..9d9b1c7 100644
--- a/README.md
+++ b/README.md
@@ -1,98 +1,72 @@
 candi (Compile &amp; Install)
 =====
 
-* Downloads, configures, builds and install deal.II
+This shell script downloads, configures, builds, and installs deal.II with common dependencies on linux-based systems.
 
-General
+Quickstart
 ----
 
-* candi is a bash script based installer tool.
-* candi is preconfigured to install a working deal.II toolchain on tested platforms
-* Open a Terminal.
-* Commands for your terminal are further denoted with the prefix "$>"
-* Do NOT copy the prefix "$>" into your terminal!
-
-Download
-----
+The following commands download the current version of the installer and then installs
+the latest deal.II release and common dependencies:
 
 ```bash
- $> git clone https://github.com/koecher/candi
+ git clone https://github.com/dealii/candi
+ cd candi
+ ./candi.sh -j2
 ```
-This downloads the current version of candi.
 
-Usage (for installing deal.II)
-----
+Follow the instructions on the screen (you can abort the process by pressing < CTRL > + C)
 
-### First Run
-Make sure, that you are in the downloaded folder of candi; e.g. after the download type in
-```bash
- $> cd candi
-```
-Note: candi is preconfigured to compile and install the current version of the deal.II library.
-
-You run the installer by
-```bash
- $> ./candi.sh
-```
-* Abort the installer by pressing < CTRL > + C
-
-### deal.II Library with Trilinos, PetSc, MPI Support, and more:
-* Make sure that you have done the First Run steps from above.
-* Abort the installer by pressing < CTRL > + C
-* READ CAREFULLY the instructions!
-* INSTALL the needed packages from your distribution. (You need super user rights for this step.)
-* SET UP the intended compilers; cf. the following instructions for this step.
+### Examples
 
 #### Install deal.II on RHEL 7, CentOS 7 or Fedora 21/22:
 ```bash
-  $> module load mpi/openmpi-`uname -i`
-  $> export CC=mpicc; export CXX=mpicxx; export FC=mpif90; export FF=mpif77
-  $> ./candi.sh
+  module load mpi/openmpi-`uname -i`
+  export CC=mpicc; export CXX=mpicxx; export FC=mpif90; export FF=mpif77
+  ./candi.sh
 ```
-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
+  export CC=mpicc; export CXX=mpicxx; export FC=mpif90; export FF=mpif77
+  ./candi.sh
 ```
-Hit return and wait.
 
 #### Install deal.II on a generic Linux cluster:
 ```bash
-  $> export CC=mpicc, export CXX=mpicxx; export FC=mpif90; export FF=mpif77
-  $> ./candi.sh --platform=./deal.II-toolchain/platforms/supported/linux_cluster.platform
+  export CC=mpicc, export CXX=mpicxx; export FC=mpif90; export FF=mpif77
+  ./candi.sh --platform=./deal.II-toolchain/platforms/supported/linux_cluster.platform
 ```
-Hit return and wait.
 Note that you probably also want to change the prefix path (see below) and 
 the path to BLAS and LAPACK in the configuration file (see below).
 
 Adapting candi to your needs
 ----
 
-### Command line options (CLO) for `./candi.sh [CLO]`
+### Command line options
+
+You can get a list of all options by running ``./candi.sh -h``
 
-* You can combine the command line options given below.
-* Read carefully the output of `./candi.sh` before running!
+You can combine the command line options given below.
 
-#### CLO: Prefix path: `[-p=<PATH>]`, `[--prefix=<PATH>]`
+#### Prefix path: `[-p=<PATH>]`, `[--prefix=<PATH>]`
 ```bash
-  $> ./candi.sh --prefix=Your/Prefix/Path
+  ./candi.sh --prefix=Your/Prefix/Path
 ```
 
-#### CLO: Multiple build processes: `[-j <N>]`, `[-j<N>]`, `[--PROCS=<N>]`
+#### Multiple build processes: `[-j <N>]`, `[-j<N>]`, `[--PROCS=<N>]`
 ```bash
-  $> ./candi.sh -j <N>
+  ./candi.sh -j <N>
 ```
 
 * Example: to use 2 build processes type `./candi.sh -j2`.
 * Be careful with this option! You need to have enough system memory (e.g. at least 8GB for 2 or more processes).
 
-### Configuration file options (CFO)
+### Configuration file options
 
-Edit the configuration file behind the softlink "candi.cfg", e.g.
+Edit the configuration file behind the file "candi.cfg", e.g.
 ```bash
-  $> gedit candi.cfg
+  gedit candi.cfg
 ```
 
 You can adapt several things to your personal needs here
@@ -102,12 +76,3 @@ You can adapt several things to your personal needs here
 * 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.