Unify the two READMEs

master
LEdoian 1 year ago
parent f9f6804f30
commit ac3508727d

@ -1,8 +1,19 @@
A simple tool for visualising OSPF network topology as seen by BIRD A simple tool for visualising OSPF network topology as seen by BIRD
==== ====
This is a tool to visualize current state of the OSPF network and compare it to <!-- My gitea cannot do README in ReST, so we write it in Markdown. -->
a reference / expected state.
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](https://bird.network.cz/) that's where the name comes from.
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. -->
## Installation ## Installation
@ -11,3 +22,12 @@ Run `pip install -e .`. You can use a virtualenv if you wish (recommended).
A demo is located in `./poor_mans_visualisation.py`, if that runs, everything A demo is located in `./poor_mans_visualisation.py`, if that runs, everything
should be working. should be working.
## Documentation
Documentation is built using [Sphinx](https://www.sphinx-doc.org/) by running `make` in the `docs/` directory.
## 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 :-)

@ -1,27 +0,0 @@
.. 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 :-)
Loading…
Cancel
Save