You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
birdvisu/README.rst

28 lines
739 B
ReStructuredText

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

.. Can we write README's in ReST also for use on Gitea? Let's see :-)
Birdvisu
@@@@@@@@
Birdvisu is a library and a graphical app to visualize routing topologies of
OSPF. It does not implement OSPF on its own, but rather exports current state
from `BIRD`_ that's where the name comes from.
Also, this is the project for my Bachelor thesis.
.. TODO: link the thesis, when it is done.
.. _BIRD: https://bird.network.cz/
Documentation
=============
Documentation is built using `Sphinx`_ by running ``make`` in the ``docs/`` directory.
.. _Sphinx: https://www.sphinx-doc.org/
Licence
=======
I have not decided yet, so please ask for terms if you want to use this in some
non-trivial way. Obviously this is source available :-)