From ac3508727ddb10af36011e5fb7cd3efe89285d14 Mon Sep 17 00:00:00 2001
From: Pavel 'LEdoian' Turinsky <ledoian@matfyz.cz>
Date: Thu, 29 Jun 2023 06:26:36 +0200
Subject: [PATCH] Unify the two READMEs

---
 README.md  | 24 ++++++++++++++++++++++--
 README.rst | 27 ---------------------------
 2 files changed, 22 insertions(+), 29 deletions(-)
 delete mode 100644 README.rst

diff --git a/README.md b/README.md
index 698bad2..58e7e08 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,19 @@
 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
-a reference / expected state.
+<!-- My gitea cannot do README in ReST, so we write it in Markdown. -->
+
+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
@@ -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
 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 :-)
diff --git a/README.rst b/README.rst
deleted file mode 100644
index bf7078a..0000000
--- a/README.rst
+++ /dev/null
@@ -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 :-)