diff --git a/MANIFEST.in b/MANIFEST.in index 276b540bd84c329ced97bb897a4b89830214c608..09e20bd1688491838ea6c2e82f866cb522b061af 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ -include README.rst LICENSE +include README.md LICENSE recursive-include doc *.py *.rst recursive-include src/bob/bio/face/data *.pb diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..6f3c87964c9f7a14dd82a8faaf75952685a17419 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +[](https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/sphinx/index.html) +[](https://gitlab.idiap.ch/bob/bob.bio.face/commits/master) +[](https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/coverage/) +[](https://gitlab.idiap.ch/bob/bob.bio.face) + +# Run face recognition algorithms + +This package is part of the signal-processing and machine learning toolbox +[Bob](https://www.idiap.ch/software/bob). +This package is part of the `bob.bio` packages, which allow to run +comparable and reproducible biometric recognition experiments on publicly +available datasets. + +This package contains functionality to run face recognition experiments. +It is an extension to the +[bob.bio.base](https://pypi.python.org/pypi/bob.bio.base) package, which +provides the basic scripts. +In this package, utilities that are specific for face recognition are +contained, such as: + +* Image databases +* Image preprocesors, including face detection and facial image alignment +* Image feature extractors +* Recognition algorithms based on image features + +## Installation + +Complete Bob's +[installation instructions](https://www.idiap.ch/software/bob/install). Then, +to install this package, run: + +``` sh +conda install bob.bio.face +``` + +## 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 66075ea4ec384c2e46e1efba7dc7b795320229ac..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. vim: set fileencoding=utf-8 : -.. Sat Aug 20 07:33:55 CEST 2016 - -.. image:: https://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/sphinx/index.html -.. image:: https://gitlab.idiap.ch/bob/bob.bio.face/badges/master/pipeline.svg - :target: https://gitlab.idiap.ch/bob/bob.bio.face/commits/master -.. image:: https://gitlab.idiap.ch/bob/bob.bio.face/badges/master/coverage.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/coverage/ -.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg - :target: https://gitlab.idiap.ch/bob/bob.bio.face - - -================================ - Run face recognition algorithms -================================ - -This package is part of the signal-processing and machine learning toolbox -Bob_. -This package is part of the ``bob.bio`` packages, which allow to run comparable and reproducible biometric recognition experiments on publicly available databases. - -This package contains functionality to run face recognition experiments. -It is an extension to the `bob.bio.base <http://pypi.python.org/pypi/bob.bio.base>`_ package, which provides the basic scripts. -In this package, utilities that are specific for face recognition are contained, such as: - -* Image databases -* Image preprocesors, including face detection and facial image alignment -* Image feature extractors -* Recognition algorithms based on image features - - - -Installation ------------- - -Complete Bob's `installation`_ instructions. Then, to install this package, -run:: - - $ conda install bob.bio.face - - -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 ed3ff1d07bc94ec4e57f71b0a684107619f332ec..65581eb57b7e8f91496a533437a1095ada08c8f8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -73,7 +73,7 @@ package-dir = {"" = "src"} [tool.setuptools.dynamic] - readme = {file = "README.rst"} + readme = {file = "README.md", content-type = "text/markdown"} [project.entry-points."bob.bio.database"] arface-all = "bob.bio.face.config.database.arface_all:database"