Load README in setup.py to appear on PyPI

- updates in readme text
- added release script

README.md

@@ -7,8 +7,10 @@ pystencils
 
 Run blazingly fast stencil codes on numpy arrays.
 
-*pystencils* uses sympy to define stencil operations, that can be executed on numpy array.
-It runs faster than normal numpy code and even as Cython and numba.
+*pystencils* uses sympy to define stencil operations, that can be executed on numpy arrays.
+Exploiting the stencil structure makes *pystencils* run faster than normal numpy code and even as Cython and numba,
+[as demonstrated in this notebook](http://pycodegen.pages.walberla.net/pystencils/notebooks/demo_benchmark.html).
+
 
 Here is a code snippet that computes the average of neighboring cells:
 ```python
@@ -48,7 +50,7 @@ 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
+-  `gpu`: use this if an 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.

release.sh

+#!/bin/bash
+
+echo "Existing versions"
+git tag -l | grep release
+
+echo "Enter the next version"
+read new_version
+
+git tag -s release/${new_version}
+git push origin master release/${new_version}
+python setup.py sdist bdist_wheel
+rm -rf dist
+twine upload dist/*
\ No newline at end of file

setup.py

@@ -47,10 +47,16 @@ class SimpleTestRunner(distutils.cmd.Command):
         for test in quick_tests:
             self._run_tests_in_module(test)
 
+def readme():
+    with open('README.md') as f:
+        return f.read()
+
 
 setup(name='pystencils',
       version=version_number_from_git(),
-      description='Python Stencil Compiler based on sympy as numpy',
+      description='Speeding up stencil computations on CPUs and GPUs',
+      long_description=readme(),
+      long_description_content_type="text/markdown",
       author='Martin Bauer',
       license='AGPLv3',
       author_email='martin.bauer@fau.de',