diff --git a/MANIFEST.in b/MANIFEST.in index 9d478e091f8ef57d74618c263e475a20010f9744..7628fbe8c4168d0b95c9edf67765975af35d05e5 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ -include README.rst COPYING +include README.md COPYING recursive-include doc *.py *.rst recursive-include bob/bio/vein/tests *.png *.txt *.hdf5 diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..65146f4db7e30e0faa998a2f5222ba5f59abefb9 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +[](https://www.idiap.ch/software/bob/docs/bob/bob.bio.vein/master/sphinx/index.html) +[](https://gitlab.idiap.ch/bob/bob.bio.vein/commits/master) +[](https://www.idiap.ch/software/bob/docs/bob/bob.bio.vein/master/coverage/) +[](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). diff --git a/README.rst b/README.rst deleted file mode 100644 index 72fcb4e9bb7e73ecb478d9b19750c90cd3b605c7..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. 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 diff --git a/pyproject.toml b/pyproject.toml index 9953aa26a62c63ea09e05126992a7c31b0066b01..8b0e96577720e0b536b498921486c5c2b3d52479 100644 --- a/pyproject.toml +++ b/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)