From 5cd3c2953c9eef7e823520874dcee719e34fb77f Mon Sep 17 00:00:00 2001
From: Yannick DAYER <yannick.dayer@idiap.ch>
Date: Wed, 10 May 2023 16:03:49 +0000
Subject: [PATCH] meta [readme]: Switch the README.rst to markdown.
---
MANIFEST.in | 2 +-
README.md | 27 +++++++++++++++++++++++++++
README.rst | 43 -------------------------------------------
pyproject.toml | 2 +-
4 files changed, 29 insertions(+), 45 deletions(-)
create mode 100644 README.md
delete mode 100644 README.rst
diff --git a/MANIFEST.in b/MANIFEST.in
index c68f21a..a58a992 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,3 @@
-include README.rst bootstrap-buildout.py COPYING
+include README.md COPYING
recursive-include doc *.py *.rst
recursive-include bob/fusion/base/test/data scores-*
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d5eb75a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+[](https://www.idiap.ch/software/bob/docs/bob/bob.fusion.base/master/sphinx/index.html)
+[](https://gitlab.idiap.ch/bob/bob.fusion.base/commits/master)
+[](https://www.idiap.ch/software/bob/docs/bob/bob.fusion.base/master/coverage/)
+[](https://gitlab.idiap.ch/bob/bob.fusion.base)
+
+# Score Fusion in Biometric Recognition and Presentation Attack Detection
+
+This package is part of the signal-processing and machine learning toolbox
+[Bob](https://www.idiap.ch/software/bob). It runs score fusion in biometric and
+presentation attack detection experiments using various algorithms. It provides
+several algorithms and scripts to be used for running and reporting fusion
+experiments.
+
+## Installation
+
+Complete Bob's
+[installation instructions](https://www.idiap.ch/software/bob/install). Then,
+to install this package, run:
+
+``` sh
+conda install bob.fusion.base
+```
+
+## 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 5b9fee3..0000000
--- a/README.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-.. vim: set fileencoding=utf-8 :
-.. Tue Jan 31 17:29:53 CET 2017
-
-.. image:: https://img.shields.io/badge/docs-latest-orange.svg
- :target: https://www.idiap.ch/software/bob/docs/bob/bob.fusion.base/master/sphinx/index.html
-.. image:: https://gitlab.idiap.ch/bob/bob.fusion.base/badges/master/pipeline.svg
- :target: https://gitlab.idiap.ch/bob/bob.fusion.base/commits/master
-.. image:: https://gitlab.idiap.ch/bob/bob.fusion.base/badges/master/coverage.svg
- :target: https://www.idiap.ch/software/bob/docs/bob/bob.fusion.base/master/coverage/
-.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
- :target: https://gitlab.idiap.ch/bob/bob.fusion.base
-
-
-=========================================================================
- Score Fusion in Biometric Recognition and Presentation Attack Detection
-=========================================================================
-
-This package is part of the signal-processing and machine learning toolbox
-Bob_. It runs score fusion in biometric and presentation attack detection
-experiments using various algorithms. It provides several algorithms and
-scripts to be used for running and reporting fusion experiments.
-
-
-Installation
-------------
-
-Complete Bob's `installation`_ instructions. Then, to install this package,
-run::
-
- $ conda install bob.fusion.base
-
-
-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
diff --git a/pyproject.toml b/pyproject.toml
index 0fb8960..4d82ae0 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -61,7 +61,7 @@
package-dir = {"" = "src"}
[tool.setuptools.dynamic]
- readme = {file = "README.rst"}
+ readme = {file = "README.md"}
[project.entry-points."bob.cli"]
fusion = "bob.fusion.base.script.fusion:fusion"
--
GitLab