From e8f92dfcb60315a5a54991632205e4f7ac5fa459 Mon Sep 17 00:00:00 2001
From: Yannick DAYER <yannick.dayer@idiap.ch>
Date: Wed, 10 May 2023 16:15:53 +0000
Subject: [PATCH] meta [readme]: Switch the README.rst to markdown.
---
MANIFEST.in | 2 +-
README.md | 24 ++++++++++++++++++++++++
README.rst | 44 --------------------------------------------
pyproject.toml | 2 +-
4 files changed, 26 insertions(+), 46 deletions(-)
create mode 100644 README.md
delete mode 100644 README.rst
diff --git a/MANIFEST.in b/MANIFEST.in
index 9d478e0..7628fbe 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 0000000..65146f4
--- /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 72fcb4e..0000000
--- 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 9953aa2..9883c25 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"}
[project.entry-points."bob.bio.config"]
# protocols (must be specified before the database in the cmd)
--
GitLab