From 85302a517775eb356a0ebd1e8230d9ed74537b9c Mon Sep 17 00:00:00 2001 From: Stephan Richter Date: Mon, 5 Apr 2021 13:52:42 +0200 Subject: [PATCH] extended doc --- README.md | 8 ++++++-- doc/setup.md | 21 +++++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 doc/setup.md diff --git a/README.md b/README.md index 1941451..771e291 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,18 @@ Es ist eine Client-Server-Anwendung. Das bedeutet: ## Ansteuerung der Modellbahn -(Siehe auch [Funktionsweise](doc/Schema.md)) - Das Signal für die Modellbahn wird mittels [SRCPD] erzeugt – dieses Programm *kann* ebenso auf dem zentralen Steuerungs-PC laufen, es kann aber auch auf einem separaten Computer installiert sein: ![Schema](doc/Web4Rail.png) [SRCPD]: http://srcpd.sourceforge.net/srcpd/index.html +## Dokumentation + +* Findest du im [doc-Ordner](doc) +* [Funktionsweise](doc/Schema.md) +* [Setup](doc/setup.md) + ## Entwicklungsstand Die Programmentwicklung hat einen Stand erreicht, mit dem sich die Software stabil für die Steuerung von Modellbahnen einsetzen lässt. Dennoch ist das Programm nicht als „fertig“ zu betrachten – es gibt immer Details zu verbessern! diff --git a/doc/setup.md b/doc/setup.md new file mode 100644 index 0000000..37e5be1 --- /dev/null +++ b/doc/setup.md @@ -0,0 +1,21 @@ +# Setup + +## Systemvoraussetzungen + +### Linux + +Web4Rail ist in Java programmiert, entsprechend braucht man folgende Programme auf dem Linux-Rechner, um Web4Rail zu bauen und zu starten: + +* Git (optional, macht aber den Download einfacher) +* Java (empfohlen: OpenJDK-11-jdk-headless) +* Maven (für das Compilieren) + +## Installation + +1. Öffne ein Terminal +2. gib ein: `git clone https://github.com/srsoftware-de/Web4Rail.git` +3. wechsle in den heruntergeladenen Ordner und gib ein: `mvn java:exec` und Maven sollte das Programm aus dem Quellcode zusammenbauen und starten. + +## Hardware + +Das Programm kann auf einem beliebigen Rechner installiert werden. Falls du es auf einem Raspberry-Pi installieren willst, brauchst du wenigstens eine Pi 3. \ No newline at end of file