Update Readme

topo-mov
LEdoian 1 year ago
parent 1a4290dd3d
commit 5f8ee9be84

@ -11,10 +11,7 @@ The main use case is comparing a reference topology (e.g. a known good one) to
the current state. This allows Birdvisu to show failed links and other
anomailes in the network.
Also, this is the project for my Bachelor thesis.
<!-- TODO: link the thesis, when it is done. -->
Also, this is the project for my Bachelor thesis, which is available at <https://gitea.ledoian.cz/LEdoian/bc_thesis>.
## Installation
@ -26,7 +23,9 @@ equivalent.
## Documentation
Documentation is built using [Sphinx](https://www.sphinx-doc.org/) by running `make` in the `docs/` directory.
~~Documentation is built using [Sphinx](https://www.sphinx-doc.org/) by running `make` in the `docs/` directory.~~
Please read the thesis and/or comments and docstrings in the source code. While many things are explained, I haven't set up Sphinx yet, sorry.
## Licence

Loading…
Cancel
Save