readme update

README.rst

@@ -11,59 +11,38 @@ ismn
 .. image:: https://badge.fury.io/py/ismn.svg
     :target: http://badge.fury.io/py/ismn
 
+.. image:: https://zenodo.org/badge/101878880.svg
+   :target: https://zenodo.org/badge/latestdoi/101878880
+
 .. image:: https://readthedocs.org/projects/ismn/badge/?version=latest
    :target: http://ismn.readthedocs.org/
 
 Readers for the data from the International Soil Moisture Database (ISMN).
 
-Description
-===========
-
-ISMN data can be downloaded for free after registration from the `ISMN Website
-<http://ismn.geo.tuwien.ac.at/>`_
-
-In case of the ISMN, two different formats are provided:
-
-* Variables stored in separate files (CEOP formatted)
-
-	this format is supported 100% and should work with all examples
-
-* Variables stored in separate files (Header+values)
-
-	this format is supported 100% and should work with all examples
+Citation
+========
 
-If you downloaded ISMN data in one of the supported formats in the past it can
-be that station names are not recognized correctly because they contained the
-'_' character which is supposed to be the separator. If you experience problems
-because of this please download new data from the ISMN since this issue should
-be fixed.
+If you use the software please cite it using the following DOI:
 
+.. image:: https://zenodo.org/badge/101878880.svg
+   :target: https://zenodo.org/badge/latestdoi/101878880
 
 Installation
 ============
 
-This package should be installable through pip::
+This package should be installable through pip:
 
-    pip install ismn
-
-Setup Development environment
------------------------------
+.. code::
 
-1. Install Miniconda_. This will give you the ``conda`` command in your shell.
-2. Run ``conda env create -f environment.yml`` this will install all the
-   dependencies listed in the ``environment.yml`` file in this repository.
-   By default this will create a new conda enviroment with the name ``ismn``.
-   This can be changed by editing the ``environment.yml`` file.
-
-.. _Miniconda: http://conda.pydata.org/miniconda.html
+    pip install ismn
 
 Example installation script
 ---------------------------
 
 The following script will install miniconda and setup the environment on a UNIX
 like system. Miniconda will be installed into ``$HOME/miniconda``.
 
-::
+.. code::
 
    wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
    bash miniconda.sh -b -p $HOME/miniconda
@@ -80,20 +59,65 @@ or ``.zshrc``
 
 The second to last line in the example activates the ``ismn`` environment.
 
-After that you should be able to run::
+After that you should be able to run:
+
+.. code::
 
     python setup.py test
 
 to run the test suite.
 
+Description
+===========
 
-Citation
-========
+ISMN data can be downloaded for free after registration from the `ISMN Website
+<http://ismn.geo.tuwien.ac.at/>`_
 
-If you use the software please cite it using the following DOI:
+In case of the ISMN, two different formats are provided:
+
+* Variables stored in separate files (CEOP formatted)
+
+	this format is supported 100% and should work with all examples
+
+* Variables stored in separate files (Header+values)
+
+	this format is supported 100% and should work with all examples
+
+If you downloaded ISMN data in one of the supported formats in the past it can
+be that station names are not recognized correctly because they contained the
+'_' character which is supposed to be the separator. If you experience problems
+because of this please download new data from the ISMN since this issue should
+be fixed.
+
+Contribute
+==========
+
+We are happy if you want to contribute. Please raise an issue explaining what
+is missing or if you find a bug. We will also gladly accept pull requests
+against our master branch for new features or bug fixes.
+
+Development setup
+-----------------
+
+For Development we also recommend a ``conda`` environment. You can create one
+including test dependencies and debugger by running
+``conda env create -f environment.yml``. This will create a new
+``ismn`` environment which you can activate by using
+``source activate ismn``.
+
+Guidelines
+----------
+
+If you want to contribute please follow these steps:
+
+- Fork the ismn repository to your account
+- Clone the repository
+- make a new feature branch from the ismn master branch
+- Add your feature
+- Please include tests for your contributions in one of the test directories.
+  We use py.test so a simple function called test_my_feature is enough
+- submit a pull request to our master branch
 
-.. image:: https://zenodo.org/badge/101878880.svg
-   :target: https://zenodo.org/badge/latestdoi/101878880
 
 Note
 ====