From b8fc724070c2233b9b8fb5e1983454089db42b66 Mon Sep 17 00:00:00 2001 From: Pavel 'LEdoian' Turinsky Date: Thu, 15 Jun 2023 13:30:55 +0200 Subject: [PATCH] Add a readme with really basic info. I do not expect the readme to contain much, it will mostly link to the documentation, which should become really complete. --- README.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..bf7078a --- /dev/null +++ b/README.rst @@ -0,0 +1,27 @@ +.. 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 :-)