Merge branch 'readme-markdown' into 'master'

meta [readme]: Switch the README.rst to markdown

See merge request !71

MANIFEST.in

-include README.rst COPYING
+include README.md COPYING
 recursive-include doc *.py *.rst
 recursive-include bob/bio/vein/tests *.png *.txt *.hdf5

README.md

+[![badge doc](https://img.shields.io/badge/docs-latest-orange.svg)](https://www.idiap.ch/software/bob/docs/bob/bob.bio.vein/master/sphinx/index.html)
+[![badge pipeline](https://gitlab.idiap.ch/bob/bob.bio.vein/badges/master/pipeline.svg)](https://gitlab.idiap.ch/bob/bob.bio.vein/commits/master)
+[![badge coverage](https://gitlab.idiap.ch/bob/bob.bio.vein/badges/master/coverage.svg)](https://www.idiap.ch/software/bob/docs/bob/bob.bio.vein/master/coverage/)
+[![badge gitlab](https://img.shields.io/badge/gitlab-project-0000c0.svg)](https://gitlab.idiap.ch/bob/bob.bio.vein)
+
+# Vein Recognition Library
+
+This package is part of the signal-processing and machine learning toolbox
+[Bob](https://www.idiap.ch/software/bob). It contains resources for finger,
+palm and wrist vein recognition as
+[bob.bio.base](https://pypi.python.org/pypi/bob.bio.base) plugins.
+
+## Installation
+
+Complete Bob's [installation instructions](https://www.idiap.ch/software/bob/install). Then, to install this package, run:
+
+``` sh
+conda install bob.bio.vein
+```
+
+## Contact
+
+For questions or reporting issues to this software package, contact our
+development [mailing list](https://www.idiap.ch/software/bob/discuss).

README.rst

-.. vim: set fileencoding=utf-8 :
-.. Fri 19 Aug 2016 13:32:51 CEST
-
-.. image:: https://img.shields.io/badge/docs-latest-orange.svg
-   :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.vein/master/sphinx/index.html
-.. image:: https://gitlab.idiap.ch/bob/bob.bio.vein/badges/master/pipeline.svg
-   :target: https://gitlab.idiap.ch/bob/bob.bio.vein/commits/master
-.. image:: https://gitlab.idiap.ch/bob/bob.bio.vein/badges/master/coverage.svg
-   :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.vein/master/coverage/
-.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
-   :target: https://gitlab.idiap.ch/bob/bob.bio.vein
-
-
-==========================
- Vein Recognition Library
-==========================
-
-
-This package is part of the signal-processing and machine learning toolbox
-Bob_. It contains resources for finger, palm and wrist vein recognition as
-`bob.bio.base`_ plugins.
-
-
-Installation
-------------
-
-Complete Bob's `installation`_ instructions. Then, to install this package,
-run::
-
-  $ conda install bob.bio.vein
-
-
-Contact
--------
-
-For questions or reporting issues to this software package, contact our
-development `mailing list`_.
-
-
-.. Place your references here:
-.. _bob: https://www.idiap.ch/software/bob
-.. _installation: https://www.idiap.ch/software/bob/install
-.. _mailing list: https://www.idiap.ch/software/bob/discuss
-.. _bob.bio.base: https://pypi.python.org/pypi/bob.bio.base

pyproject.toml

@@ -66,7 +66,7 @@
     package-dir = {"" = "src"}
 
 [tool.setuptools.dynamic]
-    readme = {file = "README.rst"}
+    readme = {file = "README.md", content-type = "text/markdown"}
 
 [project.entry-points."bob.bio.config"]
     # protocols (must be specified before the database in the cmd)