[add] readme

This commit is contained in:
Fenris Wolf 2024-09-30 09:17:37 +02:00
parent 0b3869074e
commit 3ef701b65b

30
readme.md Normal file
View file

@ -0,0 +1,30 @@
# wiki-js-cli
Inoffizieller CLI-Client für [Wiki.js](https://js.wiki/)
## Erstellung
### Voraussetzungen
- GNUMake
- TypeScript-Compiler
### Anweisungen
- `tools/build` ausführen
- nach dem Erstellen, sollte sich im Verzeichnis `build` die ausführbare Datei `wiki-js-cli` befinden
## Verwendung
### Voraussetzungen
- NodeJS
### Anweisungen
- siehe `wiki-js-cli -h`