From ab35c2675b5bfba568769de3f5ab8b11723bc524 Mon Sep 17 00:00:00 2001
From: Fenris Wolf <fenris@folksprak.org>
Date: Thu, 12 Sep 2024 20:42:14 +0200
Subject: [PATCH] [add] readme

---
 readme.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..17be3a4
--- /dev/null
+++ 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
+