From 6dc5838956d03de0b34e7149382903ce629e70a6 Mon Sep 17 00:00:00 2001
From: "Begerad, Stefan" <dialog@swingbe.de>
Date: Mon, 14 Nov 2022 15:07:36 +0100
Subject: [PATCH] chore: rename readme

---
 README.md |  3 ---
 readme.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 65 insertions(+), 5 deletions(-)
 delete mode 100644 README.md

diff --git a/README.md b/README.md
deleted file mode 100644
index 0977829..0000000
--- a/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# manual
-
-manual
\ No newline at end of file
diff --git a/readme.md b/readme.md
index 0977829..717da1a 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,66 @@
-# manual
+# Introduction
 
-manual
\ No newline at end of file
+Call ```sphinx-quickstart``` to setup the project.
+
+You can follow this guide to install Sphinx.
+
+```
+https://www.sphinx-doc.org/en/master/usage/installation.html
+```
+
+You can follow this guid to get started with Sphinx.
+
+```
+https://www.sphinx-doc.org/en/master/usage/quickstart.html#
+```
+
+# Build Documentation
+
+## Python Dependencies
+
+In order to generate the documentation,
+first create a Python virtual environment using the
+`venv` module included in Python like this.
+
+* Create a virtual Python environment in the directory `venv` like this.
+
+```
+python3 -m venv venv
+```
+
+* Activate the virtual Python environment like this.
+
+```
+source venv/bin/activate
+```
+
+* Install the packages listed in [requirements.txt](./requirements.txt) using `pip` like this.
+
+```
+pip install -r requirements.txt
+```
+
+## Running Generator via Make
+
+The top level directory contains a Makefile, for generation with all output formats use
+
+`````
+make html
+`````
+
+The output files of the final handbook can be found in the subfolder `./build`.
+
+All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.
+
+### Clean up
+
+1. Deactivate the virtual Python environment: ```deactivate```
+2. Clean up the build sources: ```make clean``` and ```rm -r build bundle```
+
+# File System
+
+* `build`: build directory
+* `make.bat`:
+* `Makefile`:
+* `readme.md`: this file
+* `source`: source directory