From: Benjamin Braatz <bb@bbraatz.eu>
Date: Fri, 22 Jan 2021 10:05:19 +0000 (+0100)
Subject: Draft documentation
X-Git-Url: http://git.graph-it.com/?a=commitdiff_plain;h=7b6099c7353fb79f8bb85217bd8e4dd824b8da0a;p=graphit%2Fschaltschrank.git

Draft documentation
---

diff --git a/doc/index.md b/doc/index.md
new file mode 100644
index 0000000..97168e5
--- /dev/null
+++ b/doc/index.md
@@ -0,0 +1,39 @@
+# Schaltschrank
+
+Schaltschrank-Prototyp mit allen Abhängigkeiten
+
+## Installation auf einem Raspberry Pi
+
+Abhängigkeiten auf apt-Ebene installieren und pigpio-Daemon aktivieren und
+starten:
+```sh
+$ sudo apt install pigpio python3-venv git
+$ sudo systemctl enable pigpiod.service
+$ sudo systemctl start pigpiod.service
+```
+
+Virtual environment anlegen (Name ist wichtig für den systemd-Service),
+pip und setuptools upgraden und schaltschrank-Paket installieren:
+```sh
+$ python3 -m venv schaltschrank-venv
+$ source schaltschrank-venv/bin/activate
+$ pip install --upgrade pip setuptools
+$ pip install git+git://git.graph-it.com/graphit/schaltschrank.git
+```
+
+schaltschrank-Repository clonen und Dateien in pi-Home-Verzeichnis
+kopieren:
+```sh
+$ git clone git://git.graph-it.com/graphit/schaltschrank.git
+$ cp schaltschrank/conf.json /home/pi/
+$ cp schaltschrank/schaltschrank.service /home/pi/
+$ cp -r schaltschrank/web/ /home/pi/
+```
+
+systemd-Service bekannt machen, aktivieren und starten:
+```sh
+$ sudo ln -s /home/pi/schaltschrank.service /etc/systemd/system/
+$ sudo systemctl enable schaltschrank.service
+$ sudo systemctl start schaltschrank.service
+$ journalctl -u schaltschrank.service
+```