39 lines
979 B
Markdown
39 lines
979 B
Markdown
|
# Mondvogel
|
||
|
|
|
||
|
|
## Beschreibung
|
||
|
|
|
||
|
|
- Kommandozeilen-Client für das [Espe](https://gitlab.die-linke.cloud/espe)
|
||
|
|
|
||
|
|
|
||
|
|
## 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
|