doc: use rst for readme and tell to install with pip

README.rst

@@ -0,0 +1,67 @@
+Pytest-executable
+=================
+
+.. image:: https://img.shields.io/pypi/v/pytest-executable.svg
+    :target: https://pypi.org/project/pytest-executable
+
+.. image:: https://img.shields.io/pypi/pyversions/pytest-executable.svg
+    :target: https://pypi.org/project/pytest-executable
+
+.. image:: https://readthedocs.org/projects/pytest-executable/badge/?version=stable
+    :target: https://pytest-executable.readthedocs.io/en/latest/?badge=stable
+    :alt: Documentation Status
+
+`pytest-executable` is a `pytest`_ plugin for checking and validating
+executables. This project is still young, but already used in a professional
+environment.
+
+Documentation
+-------------
+
+The project documentation is available `online`_.
+
+Installation
+------------
+
+Install using `pip <http://pip-installer.org/>`_:
+
+.. code-block:: console
+
+    pip install pytest-executable
+
+A `pytest-executable` package will soon be available in the Conda-Forge (just a
+matter of free time).
+
+Contributing
+------------
+
+A contributing guide will be soon available (once again, just a matter of free
+time).
+
+Please fill an issue on the `Github issue tracker`_ for any bug report, feature
+request or question.
+
+Authors
+-------
+
+-  `Antoine Dechaume`_ - *Project creator and maintainer*
+
+Copyright and License
+---------------------
+
+Copyright 2020, `CS GROUP`_
+
+`pytest-executable` is a free and open source software, distributed under the
+Apache License 2.0. See the `LICENSE.txt`_ file for more information, or the
+`quick summary`_ of this license on `tl;drLegal`_ website.
+
+.. _pytest: https://docs.pytest.org/en/latest
+.. _online: https://pytest-executable.readthedocs.io/en/stable
+.. _`doc`: doc
+.. _documentation: https://pytest-executable.readthedocs.io/en/stable/installation.html
+.. _Github issue tracker: https://github.com/CS-SI/pytest-executable/issues
+.. _Antoine Dechaume: https://github.com/AntoineD
+.. _CS GROUP: http://www.csgroup.eu
+.. _`LICENSE.txt`: LICENSE.txt
+.. _quick summary: https://tldrlegal.com/license/apache-license-2.0-(apache-2.1)
+.. _tl;drLegal: https://tldrlegal.com

doc/index.rst

@@ -16,9 +16,9 @@
 .. limitations under the License.
 
 Welcome to |ptx| documentation!
-================================
+===============================
 
-This is the user guide for |ptx|, a |pytest| plugin for checking and validating |executable|.
+This is the user guide for |ptx|, a |pytest| plugin for checking and validating an |executable|.
 
 
 Overview
@@ -67,9 +67,8 @@ result files required for performing the checks.
    :maxdepth: 2
    :caption: Contents:
 
-   installation
-   cli
    usage
+   tutorial
    test-case
    post-processing
    fixtures