From 5f8ee9be8448d92c269ad91fe84eacaebcaf275e Mon Sep 17 00:00:00 2001 From: Pavel 'LEdoian' Turinsky Date: Thu, 20 Jul 2023 19:48:03 +0200 Subject: [PATCH] Update Readme --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f006bcb..967c924 100644 --- a/README.md +++ b/README.md @@ -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. - - - +Also, this is the project for my Bachelor thesis, which is available at . ## 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