Added logo

raphaelvallat · Oct 16, 2018 · 5dbebd3 · 5dbebd3
1 parent 2c193ef
commit 5dbebd3
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 17 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,4 @@
+# Add README, LICENSE and requirements :
+include README.rst
+include LICENSE
+include requirements.txt
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,25 @@
+.. -*- mode: rst -*-
+
+
+.. figure::  docs/pictures/logo.png
+   :align:   center
+
+ EntroPy is a Python 3 package for computing several entropy metrics of time series.
+
+ It currently includes
+ - `perm_entropy`: Permutation entropy (Bandt and Pompe, 2002)
+
+
+Development
+===========
+
+EntroPy was created and is maintained by `Raphael Vallat <https://raphaelvallat.github.io>`_. Contributions are more than welcome so feel free to contact me, open an issue or submit a pull request!
+
+To see the code or report a bug, please visit the `GitHub repository <https://github.com/raphaelvallat/entropy>`_.
+
+Note that this program is provided with NO WARRANTY OF ANY KIND. If you can, always double check the results with another software.
+
+Acknowledgement
+===============
+
+Several functions of EntroPy were borrowed from:
diff --git a/docs/pictures/logo.png b/docs/pictures/logo.png