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 +