StephanRichter/Web4Rail
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Wiki Activity

extended doc

Browse Source
This commit is contained in:
Stephan Richter
2021-04-05 13:52:42 +02:00
parent 90e4100d4c
commit 85302a5177
2 changed files with 27 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -14,14 +14,18 @@ Es ist eine Client-Server-Anwendung. Das bedeutet:
## Ansteuerung der Modellbahn ## 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: 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) ![Schema](doc/Web4Rail.png)
[SRCPD]: http://srcpd.sourceforge.net/srcpd/index.html [SRCPD]: http://srcpd.sourceforge.net/srcpd/index.html
## Dokumentation
* Findest du im [doc-Ordner](doc)
* [Funktionsweise](doc/Schema.md)
* [Setup](doc/setup.md)
## Entwicklungsstand ## 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! 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!

21
doc/setup.md Normal file
View File

@@ -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.