From 61688ae6146b94248fb168fe75e4ec6b4392d112 Mon Sep 17 00:00:00 2001
From: Fenris Wolf <fenris@folksprak.org>
Date: Tue, 1 Oct 2024 06:43:36 +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..427e7a1
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,38 @@
+# Zeitbild | Web-Frontend
+
+## Beschreibung
+
+- Web-Frontend für [`zeitbild`](https://forgejo.linke.sx/zeitbild/backend)
+
+
+## Erstellung
+
+### Voraussetzungen
+
+- GNU Make
+
+
+### Anweisungen
+
+- siehe `tools/build -h`
+
+
+## Test
+
+(noch keine vorhanden)
+
+
+## Betrieb
+
+### Voraussetzungen
+
+- wahlweise einen Python-Interpreter oder ein vollwertiger Web-Server (nginx, Apache, lighttpd, …)
+- zum Aufruf wird ein halbwegs aktueller Web-Browser vorausgesetzt
+
+
+### Anweisungen
+
+- `conf.json` im build-Verzeichnis anlegen
+- für Entwicklung und Test kann der Python-Webserver genutzt werden: ins build-Verzeichnis wechseln und `python3 -m http.server [port]` ausführen
+- für Produktiv-Umgebungen sollte eine vhost-Konfiguration für den Web-Server angelegt werden
+