Commit 482edadc authored by Samuel GAIST's avatar Samuel GAIST

[readme] Add link to user guide

parent b72f8ca1
Pipeline #23573 passed with stages
in 4 minutes and 43 seconds
......@@ -43,6 +43,7 @@ algorithms and workflows. It contains the minimum amount of code needed to run
user algorithms or inject data in toolchains from locally installed raw data
assets.
The `User Guide`_ provides installation and usage instructions.
Installation
------------
......@@ -64,3 +65,4 @@ development `mailing list`_.
.. _beat: https://www.idiap.ch/software/beat
.. _installation: https://www.idiap.ch/software/beat/install
.. _mailing list: https://www.idiap.ch/software/beat/discuss
.. _user guide: https://www.idiap.ch/software/beat/docs/beat/beat.backend.python/master/index.html
  • @samuel.gaist: the link to the installation should be on the top, following the icons as in other packages to keep uniformity. Currently and unfortunately the link points to a non-existing document. Please keep track of this so that, when that link is properly set you remove this line from the README.

Please register or sign in to reply
\ No newline at end of file
  • I followed the bob.bio.base README.rst which provides a link to the user guide in the explanation text as here. And the link is working properly.

    The links on top looks like they are the same.

    Therefore, I don't see where the problem is currently.

Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment