README hinzugefügt

main
Alexander Böhm 2022-01-30 18:13:12 +01:00
parent be29d1f016
commit b70708d326
1 changed files with 36 additions and 0 deletions

36
README.md Normal file
View File

@ -0,0 +1,36 @@
# Freifunk Leipzig Dokumentation
## Prozess für Änderungen
TBD.
MR, 4-Augen-Prinzip ...
## Build
Die Seite wird mit [Hugo](https://gohugo.io) erzeugt.
Zuerst muss das Repository mittels `git` und alles Submodulen ausgecheckt werden:
```sh
git clone --recursive https://git.dezentrale.cloud/Freifunk-Leipzig/documentation
```
Zum erstellen der Seite muss dann nur `hugo` aufgerufen werden:
```sh
hugo
```
Die fertige Website-Dateien werden dann im Verzeichnis `public` erstellt bzw. aktualisiert und können dann ggf. auf einen Webserver kopiert werden.
Für eine lokale Ansicht mit der Übernahme von Änderungen in Echtzeit bspw. für die Bearbeitung, kann folgender Befehl ausgeführt werden
```
hugo server
```
Die Website ist dann auf dem Rechner unter [http://localhost:1313](http://localhost:1313) abrufbar.