Merge pull request #50 from nschloe/rst

enable RST longdesc

.gitignore

@@ -5,3 +5,4 @@ build
 MANIFEST
 gh-pages
 .coverage
+README.rst

Makefile

@@ -0,0 +1,13 @@
+
+default:
+	@echo "\"make upload\"?"
+
+README.rst: README.md
+	pandoc README.md -o README.rst
+	python setup.py check -r -s || exit 1
+
+upload: setup.py README.rst
+	python setup.py sdist upload --sign
+
+clean:
+	rm -f README.rst

README.md

@@ -1,4 +1,10 @@
-# KryPy [![Build Status](https://travis-ci.org/andrenarchy/krypy.png?branch=master)](https://travis-ci.org/andrenarchy/krypy) [![doi](https://zenodo.org/badge/doi/10.5281/zenodo.10283.png)](https://zenodo.org/record/10283)
+# KryPy
+
+[![Build Status](https://travis-ci.org/andrenarchy/krypy.png?branch=master)](https://travis-ci.org/andrenarchy/krypy)
+[![Documentation Status](https://readthedocs.org/projects/krypy/badge/?version=latest)](http://krypy.readthedocs.org/en/latest/?badge=latest)
+[![doi](https://zenodo.org/badge/doi/10.5281/zenodo.10283.png)](https://zenodo.org/record/10283)
+[![Pypi version](https://img.shields.io/pypi/v/krypy.svg)](https://pypi.python.org/pypi/krypy)
+[![Pypi downloads](https://img.shields.io/pypi/dm/krypy.svg)](https://pypi.python.org/pypi/krypy)
 
 KryPy is a Python (versions 2 and 3) module for Krylov subspace methods for the solution of linear algebraic systems. This includes enhanced versions of CG, MINRES and GMRES as well as methods for the efficient solution of sequences of linear systems.
 
@@ -21,7 +27,7 @@ The documentation is hosted at
 [krypy.readthedocs.org](http://krypy.readthedocs.org).
 
 ### Example
-![GMRES convergence history](example.png)
+![](https://raw.githubusercontent.com/nschloe/krypy/master/example.png)
 
 The above convergence history is obtained with the following example where the
 [Gmres](http://krypy.readthedocs.org/en/latest/krypy.linsys.html#krypy.linsys.Gmres)
@@ -52,8 +58,8 @@ parameters such as the residual tolerance.
 ### Help
 
 Help can be optained via Python's builtin help system. For example, you can use
-the ```?``` in ```ipython```:
-```ipython
+the `?` in `ipython`:
+```python
 from krypy.linsys import Gmres
 ?Gmres
 ```
@@ -76,6 +82,24 @@ KryPy is currently maintained by [André Gaul](http://www.math.tu-berlin.de/~gau
 
 KryPy is developed with continuous integration. Current status: [![Build Status](https://travis-ci.org/andrenarchy/krypy.png?branch=master)](https://travis-ci.org/andrenarchy/krypy)
 
+### Distribution
+
+To create a new release
+
+1. bump the `__version__` number,
+
+2. create a Git tag,
+    ```
+    $ git tag -a v0.3.1
+    $ git push --tags
+    ```
+    and
+
+3. upload to PyPi:
+    ```
+    $ make upload
+    ```
+
 
 # License
 

setup.py

@@ -15,7 +15,7 @@ def read(fname):
       packages=['krypy', 'krypy.recycling'],
       version=__version__,
       description='Krylov subspace methods for linear systems',
-      long_description=read('README.md'),
+      long_description=read('README.rst'),
       author='André Gaul',
       author_email='gaul@web-yard.de',
       url='https://github.com/andrenarchy/krypy',