[add] readme

2024-09-12 20:42:14 +02:00 · 2024-09-12 20:42:14 +02:00 · ab35c2675b
commit ab35c2675b
parent 7c7bb3f66a
1 changed files with 38 additions and 0 deletions
--- a/readme.md
+++ b/readme.md
@ -0,0 +1,38 @@
+# Zeitbild | Backend
+
+## Beschreibung
+
+- Hintergrund-Dienst für Kalendar-Erstellung und -Darstellung
+
+
+## Erstellung
+
+### Voraussetzungen
+
+- GNU Make
+- NodeJS
+
+
+### Anweisungen
+
+- `tools/build` ausführen
+
+
+## Test
+
+(noch keine vorhanden)
+
+
+## Betrieb
+
+### Voraussetzungen
+
+- NodeJS
+
+
+### Anweisungen
+
+- ins Erzeugnis-Verzeichnis wechseln
+- `./zeitbild -h` ausführen
+- für die meisten Anwendungsfälle ist es erforderlich eine Konfigurations-Datei anzulegen
+