frontend-mondvogel/readme.md

39 lines
976 B
Markdown
Raw Normal View History

2025-09-22 18:34:04 +02:00
# Espe | Frontend: Mondvogel
2024-06-21 14:04:58 +02:00
## Beschreibung
2025-09-22 21:29:56 +02:00
- Kommandozeilen-Client für das [Espe](/misc/espe-meta)
2024-06-21 14:04:58 +02:00
## Erstellung
### Voraussetzungen
- (keine)
### Anweisungen
- `tools/build <ziel-verzeichnis>` ausführen
## Benutzung
### Voraussetzungen
- Python 3 (Debian-Paket-Name: `python3`)
### Anweisungen
- Ausführung
- `python3 <ziel-verzeichnis>/main.py` ausführen
- durch Anfügen des Schalters `-h`/`--help` wird die Erläuterung zur Syntax angezeigt
- Konfiguration
- `misc/conf.example.json` kopieren nach (bspw.) `~/.mondvogel/conf.json` und die Werte anpassen um eine initiale Konfiguration zu erstellen
- das JSON-Schema der Konfiguration mit Hinweisen zu den verfügbaren Optionen lässt sich durch die Aktion `conf-schema` ausgeben
- die vervollständigte Konfiguration lässt sich durch die Aktion `conf-expose` anzeigen
- Installation
- als `root` `tools/install` ausführen
- dadurch sollte `mondvogel` als systemweiter Befehl verwendbar sein