diff --git a/MANIFEST.in b/MANIFEST.in index 47a5123233bc277f65c860d07e23c38d6a44c41f..26fe1041137836b6bbcbb71ba26de320643d4604 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include README.rst COPYING +include README.md COPYING recursive-include doc *.py *.rst recursive-include tests/data *.hdf5 *.wav *.npy recursive-include src/bob/bio/spear/config/database *.py *.lst diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..7fd0b1df5d6f98c676336a0e6c7d2d882ffb0ba7 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +[](https://www.idiap.ch/software/bob/docs/bob/bob.bio.spear/master/sphinx/index.html) +[](https://gitlab.idiap.ch/bob/bob.bio.spear/commits/master) +[](https://www.idiap.ch/software/bob/docs/bob/bob.bio.spear/master/coverage/index.html) +[](https://gitlab.idiap.ch/bob/bob.bio.spear) + +# Run speaker 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 +databases. + +This package contains functionality to run speaker 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. +This package contains utilities that are specific for speaker recognition, such +as: + +* Audio databases +* Voice activity detection preprocessing +* Acoustic feature extractors +* Recognition algorithms based on acoustic features + +For further information about `bob.bio`, please read +[its Documentation](https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/master/sphinx/index.html). + +## Installation + +Complete Bob's +[installation instructions](https://www.idiap.ch/software/bob/install). Then, +to install this package, run: + +``` sh +pip install bob.bio.spear +``` + +## 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 6a76728aa85ab9764e4bea3fb65738590d01dff4..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. vim: set fileencoding=utf-8 : -.. Sun Aug 21 09:26:51 CEST 2016 - -.. image:: https://img.shields.io/badge/docs-latest-orange.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.spear/master/sphinx/index.html -.. image:: https://gitlab.idiap.ch/bob/bob.bio.spear/badges/master/pipeline.svg - :target: https://gitlab.idiap.ch/bob/bob.bio.spear/commits/master -.. image:: https://gitlab.idiap.ch/bob/bob.bio.spear/badges/master/coverage.svg - :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.spear/master/coverage/index.html -.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg - :target: https://gitlab.idiap.ch/bob/bob.bio.spear - - -=================================== - Run speaker 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 speaker 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 speaker recognition are contained, such as: - -* Audio databases -* Voice activity detection preprocessing -* Acoustic feature extractors -* Recognition algorithms based on acoustic features - -For further information about ``bob.bio``, please read `its Documentation <https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/master/index.html>`_. - - -Installation ------------- - -Complete Bob's `installation`_ instructions. Then, to install this package, -run:: - - $ pip install bob.bio.spear - - -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 bfbf6906f94743bd198fef9c2c09e5eb7281f57c..ff67ba34c9d09e0db68b375b3f598f2eb6378fa7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -65,7 +65,7 @@ package-dir = {"" = "src"} [tool.setuptools.dynamic] - readme = {file = "README.rst"} + readme = {file = "README.md", content-type = "text/markdow"} [project.entry-points."bob.bio.database"] timit = "bob.bio.spear.config.database.timit:database"