Update README.md

Readme.md: updated documentation for candi

diff --git a/README.md b/README.md
index 9830fba63fcce35972d543652d86451c9837b184..3ee97f18e54b86ed948f432ba5f3c370470131e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,3 +2,44 @@ candi
 =====
 
 candi - (Compile & Install) - Downloads, configures, builds and install various FEM libraries, e.g. deal.II, FEniCS
+
+General instruction hints
+----
+candi is a bash script based installer tool.
+
+Open a Terminal. Commands are further denoted with the prefix "$>"
+
+Do not copy the prefix "$>" into your terminal!
+
+Download
+----
+
+```bash
+ $> git clone https://github.com/koecher/candi
+```
+This downloads the current version of candi.
+
+Usage
+----
+
+### deal.II Library with MPI Support, Trilinos, PetSc, HDF5, and more:
+
+candi is initially configured to compile and install the current version of the deal.II library.
+
+```bash
+ $> cd candi
+ $> ./candi.sh
+```
+
+* Abort the installer by pressing < CTRL > + C
+* Read Carefully the instructions!
+* Install the needed packages from your distribution. (For that, you need super user rights.)
+* Set up of the needed compilers
+
+#### Install deal.II on RHEL 7, CentOS 7 or Fedora 20/21:
+```bash
+  $> module load mpi/openmpi-x86_64
+  $> export CC=mpicc; export CXX=mpicxx; export FC=mpif90; export FF=mpif77
+  $> ./candi.sh
+```
+Hit return and wait.