From 2e8820519a20948e41ed0fc634d14639681bb89f Mon Sep 17 00:00:00 2001
From: Pavel 'LEdoian' Turinsky <ledoian@matfyz.cz>
Date: Thu, 20 Jul 2023 19:38:08 +0200
Subject: [PATCH] Inform the user that there is no explicit documentation

---
 docs/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 docs/README.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..0f08f7f
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,10 @@
+It might seem like that this directory contains documentation. However, that is
+not the case at the moment (I did not manage to persuade Sphinx to produce
+reasonable output). Please read the
+[thesis](https://gitea.ledoian.cz/LEdoian/bc_thesis) for overview and the many
+comments and docstrings in the source code for details.
+
+The fourth chapter of the thesis provides a guide to use Birdvisu, the third
+describes the design.
+
+Sorry for the inconvenience.