Commit 4e02f309 authored by Federico Vaga's avatar Federico Vaga

add README file

Signed-off-by: Federico Vaga's avatarFederico Vaga <>
parent 45c33cd1
FMC TDC 1 ns 5 Channels
For the documentation we use `Sphinx`_ and `Doxygen`_. You can build
it yourself using ``make`` and specifying the output target. For
example, to build an HTML website you can type the following command
from the project's top directory.
make -C doc html
You will find the documentation in ``doc/_build/html``.
If the build fails, you are probably missing some required
packages. Have a look at the requirements file
``doc/requirements.txt``. You can install them from your sidtribution
repository or them from `PyPI`_ using the following command.
pip install -r doc/requirements.txt
Remember also to install `Doxygen`_ on your system.
.. _`Sphinx`:
.. _`Doxygen`:
.. _`PyPI`:
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