From da24cd10334c9d5087faacb8b2498405437317bb Mon Sep 17 00:00:00 2001
From: Martin Bauer <martin.bauer@fau.de>
Date: Fri, 22 Mar 2019 14:44:10 +0100
Subject: [PATCH] Update readme and wrote separate readme's for packages

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

diff --git a/README.md b/README.md
index a6a949767..bd3680317 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,35 @@
 pystencils
 ==========
 
+Run blazingly fast stencil codes on numpy arrays.
 
 ![alt text](doc/img/logo.png)
 
+
+Installation
+------------
+
+```bash
+export PIP_EXTRA_INDEX_URL=https://www.walberla.net/pip
+pip install pystencils[interactive]
+```
+
+Without `[interactive]` you get a minimal version with very little dependencies.
+
+All options:
+-  `gpu`: use this if nVidia GPU is available and CUDA is installed
+- `alltrafos`: pulls in additional dependencies for loop simplification e.g. libisl
+- `bench_db`: functionality to store benchmark result in object databases
+- `interactive`: installs dependencies to work in Jupyter including image I/O, plotting etc.
+- `doc`: packages to build documentation
+
+Options can be combined e.g.
+```bash
+pip install pystencils[interactive,gpu,doc]
+```    
+
+
+Documentation
+-------------
+
+Read the docs [here](http://software.pages.walberla.net/pystencils/pystencils)
\ No newline at end of file
-- 
GitLab