Merge branch 'readme-markdown' into 'master'

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

See merge request !110

MANIFEST.in

-include README.rst
+include README.md COPYING
 recursive-include doc *.py *.rst
-recursive-include bob *.txt *.hdf5
-recursive-include bob *.sql3
 recursive-include tests/data scores-* *.sql3 *.wav
 recursive-include tests/example_filelist *.lst
 recursive-include tests/ *.csv

README.rst → README.md

-.. vim: set fileencoding=utf-8 :
-.. Pavel Korshunov <pavel.korshunov@idiap.ch>
-.. Wed 19 Oct 22:36:22 2016 CET
-
-.. image:: https://img.shields.io/badge/docs-latest-orange.svg
-   :target: https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/sphinx/index.html
-.. image:: https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/pipeline.svg
-   :target: https://gitlab.idiap.ch/bob/bob.pad.base/commits/master
-.. image:: https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/coverage.svg
-   :target: https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/coverage/
-.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
-   :target: https://gitlab.idiap.ch/bob/bob.pad.base
-
-========================================
-Scripts to run anti-spoofing experiments
-========================================
-
-This package is part of the signal-processing and machine learning toolbox Bob_.
-This package is the base of ``bob.pad`` family of packages, which allow to run
-comparable and reproducible presentation attack detection (PAD) experiments on
-publicly available databases.
+[![badge doc](https://img.shields.io/badge/docs-latest-orange.svg)](https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/sphinx/index.html)
+[![badge pipeline](https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/pipeline.svg)](https://gitlab.idiap.ch/bob/bob.pad.base/commits/master)
+[![badge coverage](https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/coverage.svg)](https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/coverage/)
+[![badge gitlab](https://img.shields.io/badge/gitlab-project-0000c0.svg)](https://gitlab.idiap.ch/bob/bob.pad.base)
+
+# Scripts to run anti-spoofing experiments
+
+This package is part of the signal-processing and machine learning toolbox
+[Bob](https://www.idiap.ch/software/bob).
+This package is the base of the `bob.pad` family of packages, which allow to
+run comparable and reproducible presentation attack detection (PAD) experiments
+on publicly available databases.
 
 This package contains basic functionality to run PAD experiments.
 It provides a generic API for PAD including:
@@ -33,25 +24,19 @@ All the algorithms are standardized on top of scikit-learn estimators.
 
 In this base package, only a core functionality is implemented. The specialized
 algorithms should be provided by other packages, which are usually in the
-``bob.pad`` namespace, like ``bob.pad.face``.
-
-Installation
-------------
+`bob.pad` namespace, like
+[`bob.pad.face`](https://gitlab.idiap.ch/bob/bob.pad.face).
 
-Complete Bob's `installation`_ instructions. Then, to install this package,
-run::
+## Installation
 
-  $ conda install bob.pad.base
+Complete Bob's
+[installation instructions](https://www.idiap.ch/software/bob/install). Then,
+to install this package, run:
+``` sh
+conda install bob.pad.base
+```
 
-
-Contact
--------
+## 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://groups.google.com/forum/?fromgroups#!forum/bob-devel
+development [mailing list](https://www.idiap.ch/software/bob/discuss).

pyproject.toml

@@ -70,7 +70,7 @@
     package-dir = {"" = "src"}
 
 [tool.setuptools.dynamic]
-    readme = {file = "README.rst"}
+    readme = {file = "README.md", content-type = "text/markdown"}
 
 [project.entry-points."bob.cli"]
     pad               = "bob.pad.base.script.pad:pad"