diff --git a/MANIFEST.in b/MANIFEST.in index f7dc149f8d78997a15758351ff138c314ef02cfc..14e81e637dd404acc75ff1b340c627dbc787428f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ -include LICENSE README.rst +include LICENSE README.md recursive-include doc conf.py *.rst recursive-include bob/tests/data *.* diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..00c0033933b84ce00ca32084d7ad22bb7e6c6922 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +[](https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/sphinx/index.html) +[](https://gitlab.idiap.ch/bob/bob.measure/commits/master) +[](https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/coverage/) +[](https://gitlab.idiap.ch/bob/bob.measure) + +# Experiment Evaluation Metrics for Bob + +This package is part of the signal-processing and machine learning toolbox +[Bob](https://www.idiap.ch/software/bob). It contains common routines for +assessing performance of machine learning experiments. + +## Installation + +Complete Bob's +[installation instructions](https://www.idiap.ch/software/bob/install). + +Then, to install this package, run: + +``` sh +conda install bob.measure +``` + +## 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 053d9494a446de55e04b6f477a858ea945b5866b..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. vim: set fileencoding=utf-8 : -.. Thu 11 Aug 14:52:51 CEST 2016 - -.. image:: https://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/sphinx/index.html -.. image:: https://gitlab.idiap.ch/bob/bob.measure/badges/master/pipeline.svg - :target: https://gitlab.idiap.ch/bob/bob.measure/commits/master -.. image:: https://gitlab.idiap.ch/bob/bob.measure/badges/master/coverage.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/coverage/ -.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg - :target: https://gitlab.idiap.ch/bob/bob.measure - - -======================================= - Experiment Evaluation Metrics for Bob -======================================= - -This package is part of the signal-processing and machine learning toolbox -Bob_. It contains common routines for assessing performance of machine learning -experiments. - - -Installation ------------- - -Complete Bob's `installation`_ instructions. Then, to install this package, -run:: - - $ conda install bob.measure - - -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 34338f2fa1f58de868269c419e99181dab80c0ea..8a57cc89cbf94eef5cc9b97951d242c89bead89d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -63,7 +63,7 @@ package-dir = {"" = "src"} [tool.setuptools.dynamic] - readme = {file = "README.rst"} + readme = {file = "README.md", content-type = "text/markdown"} [project.entry-points."bob.cli"] measure = "bob.measure.script.measure:measure"