Merge pull request easybuilders#1085 from boegel/README_docs

update/cleanup README

README.rst

@@ -1,54 +1,57 @@
-Build status - *master branch (Python 2.4, Python 2.6, Python 2.7)*
-
-.. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master-python24/badge/icon
-    :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master-python24/
-.. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master/badge/icon
-    :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master/  
-.. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master-python27/badge/icon
-    :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master-python27/ 
-
-Build status - *develop branch (Python 2.4, Python 2.6, Python 2.7)*
-
-.. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop-python24/badge/icon
-    :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop-python24/  
-.. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop/badge/icon
-    :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop/  
-.. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop-python27/badge/icon
-    :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop-python27/
-
-EasyBuild: building software with ease
---------------------------------------
-
-The easybuild-framework package is the basis for EasyBuild
-(http://hpcugent.github.com/easybuild), a software build and
-installation framework written in Python that allows you to install
-software in a structured, repeatable and robust way.
-
-This package contains the EasyBuild framework that supports the
-implementation and use of so-called easyblocks, that implement the
-software install procedure for a particular (group of) software
+.. image:: http://hpcugent.github.io/easybuild/images/easybuild_logo_small.png
+   :align: center
+
+`EasyBuild <https://hpcugent.github.io/easybuild>`_ is a software build
+and installation framework that allows you to manage (scientific) software
+on High Performance Computing (HPC) systems in an efficient way.
+
+The **easybuild-framework** package is the core of EasyBuild. It
+supports the implementation and use of so-called easyblocks which
+implement the software install procedure for a particular (group of) software
 package(s).
 
-The code of the easybuild-framework package is hosted on GitHub, along
+The EasyBuild documentation is available at http://easybuild.readthedocs.org/.
+
+The EasyBuild framework source code is hosted on GitHub, along
 with an issue tracker for bug reports and feature requests, see
 http://github.com/hpcugent/easybuild-framework.
 
-The EasyBuild documentation is available on the GitHub wiki of the
-easybuild meta-package, see
-http://github.com/hpcugent/easybuild/wiki/Home.
-
-Related packages: 
-- easybuild-easyblocks
-(http://pypi.python.org/pypi/easybuild-easyblocks): a collection of
-easyblocks that implement support for building and installing (groups
-of) software packages.
-
-- easybuild-easyconfigs
-(http://pypi.python.org/pypi/easybuild-easyconfigs): a collection of
-example easyconfig files that specify which software to build, and using
-which build options; these easyconfigs will be well tested with the
-latest compatible versions of the easybuild-framework and
-easybuild-easyblocks packages.
-
-The code in the vsc directory originally comes from VSC-tools
-(https://github.com/hpcugent/VSC-tools).
+Related Python packages:
+
+* **easybuild-easyblocks**
+
+  * a collection of easyblocks that implement support for building and installing (groups of) software packages
+  * GitHub repository: http://github.com/hpcugent/easybuild-easyblocks
+  * package on PyPi: https://pypi.python.org/pypi/easybuild-easyblocks
+
+* **easybuild-easyconfigs**
+
+  * a collection of example easyconfig files that specify which software to build,
+    and using which build options; these easyconfigs will be well tested
+    with the latest compatible versions of the easybuild-framework and easybuild-easyblocks packages
+  * GitHub repository: http://github.com/hpcugent/easybuild-easyconfigs
+  * PyPi: https://pypi.python.org/pypi/easybuild-easyconfigs
+
+The code in the ``vsc`` directory originally comes from the *vsc-base* package
+(https://github.com/hpcugent/vsc-base).
+
+
+*Build status overview:*
+
+* **master** branch *(Python 2.4, Python 2.6, Python 2.7)*
+
+  .. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master-python24/badge/icon
+      :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master-python24/
+  .. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master/badge/icon
+      :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master/
+  .. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master-python27/badge/icon
+      :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_master-python27/
+
+* **develop** branch *(Python 2.4, Python 2.6, Python 2.7)*
+
+  .. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop-python24/badge/icon
+      :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop-python24/
+  .. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop/badge/icon
+      :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop/
+  .. image:: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop-python27/badge/icon
+      :target: https://jenkins1.ugent.be/view/EasyBuild/job/easybuild-framework_unit-test_hpcugent_develop-python27/

setup.py

@@ -82,9 +82,7 @@ def find_rel_test():
     version = str(VERSION),
     author = "EasyBuild community",
     author_email = "easybuild@lists.ugent.be",
-    description = """EasyBuild is a software installation framework in Python that allows you to \
-install software in a structured and robust way.
-This package contains the EasyBuild framework, which supports the creation of custom easyblocks that \
+    description = """The EasyBuild framework supports the creation of custom easyblocks that \
 implement support for installing particular (groups of) software packages.""",
     license = "GPLv2",
     keywords = "software build building installation installing compilation HPC scientific",
@@ -96,12 +94,7 @@ def find_rel_test():
     data_files = [
         ('easybuild', ["easybuild/easybuild_config.py"]),
     ],
-    long_description = """This package contains the EasyBuild
-framework, which supports the creation of custom easyblocks that
-implement support for installing particular (groups of) software
-packages.
-
-""" + read("README.rst"),
+    long_description = read('README.rst'),
     classifiers = [
         "Development Status :: 5 - Production/Stable",
         "Environment :: Console",