From 87ef72dcab67b3fd9d431d62e4f521db4dae5a2c Mon Sep 17 00:00:00 2001
From: gulliver <gulliver@noreply.git.wtf-eg.de>
Date: Thu, 5 Aug 2021 22:15:18 +0200
Subject: [PATCH] =?UTF-8?q?=E2=80=9EREADME.md=E2=80=9C=20=C3=A4ndern?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 43 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8f334e0..3a61aff 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 this projects is an experiment of how to generate html, epub and pdf
 from the git repository for the WTF Handbook.
-The handbuch sources are inclued as git submodule.
+The handbuch sources are included as git submodule.
 
 It contains a configuration for three different generators:
 
@@ -20,8 +20,49 @@ tbd more details on README.md in sphinx directory
 
 ## How to build
 
-tbd
+### rust based tools mdbook and crowbook
 
+For building you need a rust installation.
+This can be achieved by using the installer from https://rustup.rs
+
+After installing the rust toolchain for your platform you have to install the needed tools:
+````
+cargo install mdbook
+cargo install mdbook-epub
+cargo install crowbook
+````
+
+Crowbook needs xelatex for building the pdf outputs.
+
+### python based - sphinx
+
+First create a Python 3 virtual environment using the venv module included with Python 3.
+
+````
+ python -m venv py3-sphinx
+`````
+
+Now “activate” the environment. Look for the name of the virtual environment enclosed in parenthesis after activation.
+
+`````
+ source py3-sphinx/bin/activate
+``````
+
+Expected Output
+`````
+ (py3-sphinx) $
+``````
+
+In the virtual environment install the following modules with pip:
+
+`````
+ (py3-sphinx) $ pip install sphinx3 sphinxcontrib-plantuml myst_parser
+``````
+
+For generating the images from plantuml-sources it needs also [Plantuml](https://plantuml.com/).
+For pdf output the latex builder is used, so it needs also an installed latex and pdflatex.
+
+## 
 ## Issues
 ### mdbook - rendering problem with current inputs