Top level README changed to use the same README that is inside the pa…

…ckage

README.rst

@@ -0,0 +1,69 @@
+==============
+McsPyDataTools
+==============
+
+.. image:: https://img.shields.io/pypi/v/McsPyDataTools.svg
+        :target: https://pypi.python.org/pypi/McsPyDataTools
+        :alt: PyPI - Version
+
+.. image:: https://img.shields.io/pypi/status/McsPyDataTools.svg
+        :target: https://pypi.python.org/pypi/McsPyDataTools
+        :alt: PyPI Status
+
+.. image:: https://img.shields.io/pypi/pyversions/McsPyDataTools.svg
+        :target: https://pypi.python.org/pypi/McsPyDataTools
+        :alt: Python Versions
+
+.. image:: https://img.shields.io/pypi/l/McsPyDataTools.svg
+        :target: https://github.com/multichannelsystems/McsPyDataTools/blob/master/McsPyDataTools/LICENSE.txt
+        :alt: PyPI - License
+
+.. image:: https://img.shields.io/github/last-commit/multichannelsystems/McsPyDataTools.svg
+        :target: https://github.com/multichannelsystems/McsPyDataTools
+        :alt: Last Commit
+
+.. image:: https://readthedocs.org/projects/mcspydatatools/badge/?version=latest
+        :target: https://McsPyDataTools.readthedocs.io/en/latest/?badge=latest
+        :alt: Documentation Status
+
+This package contains Python tools, classes and functions, to handle data recorded
+and processed with Hard- and Software produced by `Multi Channel Systems MCS GmbH <https://www.multichannelsystems.com>`_.
+
+Feature list
+============
+
+* Read HDF5 data files that are compliant to the MCS-HDF5 Raw-Data protocol v. 3 (usually generated by the HDF5 export function of the Multi Channel DataManager)
+* Read data files that are compliant to the HDF5 based MCS-CMOS-MEA RawData format CMOS-MEA RawData protocol v. 1 (generated by CMOS-MEA-Control) and ProcessedData format CMOS-MEA ProcessedData v. 1 (generated by CMOS-MEA-Tools)
+* Provides structures to get the recorded raw ADC integer values and the meta data of every stream
+* Provides methods to get the measured values and timestamps in the correct context of the recording (scale, physical unit, ... etc.)
+
+Documentation
+=============
+
+Documentation is available at https://McsPyDataTools.readthedocs.io
+
+Source Code
+===========
+
+Source code is available at https://github.com/multichannelsystems/McsPyDataTools
+
+Test file archive
+=================
+
+The **McsPyDataTools** package is accompanied by a separate archive that contains the
+the raw data files used by the unit tests. The content of this test file archive must
+be copied to the folder **...\\McsPy\\Test\\TestData\\** to be used by the unit tests.
+The test file archive can be downloaded at https://www.multichannelsystems.com/software/multi-channel-datamanager.
+
+Installation
+============
+
+To install the **McsPyDataTools**, run the pip command in your terminal:
+
+.. code-block:: console
+
+    $pip install McsPyDataTools
+
+:History: See HISTORY.rst for details
+:Copyright: Copyright 2018 by Multi Channel Systems MCS GmbH, see AUTHORS.rst
+:License: See LICENSE.txt for details