From ff43a4ba3d38b07520af54a6a22b30c81c7f49a7 Mon Sep 17 00:00:00 2001
From: Jan Ulrich Hasecke <jan.ulrich@hasecke.com>
Date: Thu, 28 Nov 2019 14:01:30 +0100
Subject: [PATCH] README

---
 README.md |   34 ++++++++++++++++++++++++++++++++++
 1 files changed, 34 insertions(+), 0 deletions(-)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..210238b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Lokale Installation der Dokumentation
+
+Dies ist eine vorläufige Beschreibung zur Installation der Dokumentation auf einem lokalen Rechner.
+Wenn die Dokumentation in unseren Internetauftritt integriert ist, werden andere Schritte nötig sein.
+
+Zuerst eine virtuelle Python-Umgebung erzeugen und aktivieren:
+
+    $ python3 -m venv doku
+    $ . ./doku/bin/activate
+
+Anschließend Sphinx und das Readthedocs-Theme installieren.
+Das Theme ist weit verbreitet und gut lesbar. 
+Bei einer Veröffentlichung wird es vermuitlich ein Theme geben, das mit unserem CD besser übereinstimmt.
+Fürs erste eignet sich das Theme gut zum Korrekturlesen.
+
+    $ pip install -U Sphinx
+    $ pip install sphinx_rtd_theme
+    
+Dann die Dokumentation mit Git klonen:
+
+    $ git clone ssh://DEIN-BENUTZERNAME@dev.hostsharing.net:29418/docs/hs.docs.users.git
+  
+Und die Dokumentation bauen.
+Für die HTML-Version:
+
+    $ cd hs.docs.users
+    $ make html
+
+Für die PDF-Version:
+
+    $ make latexpdf
+    
+Um die PDF-Version mit Hilfe von LaTeX zu erzeugen, ist eine sehr umfangreiche LaTeX-Installation notwendig.
+Wer mit einer minimalen LaTeX-Installation startet, muss viele Pakete nachinstallieren.
\ No newline at end of file

--
Gitblit v1.9.0-SNAPSHOT