diff --git a/README.md b/README.md new file mode 100644 index 0000000..f32d00b --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# HertzSCHLAG Archiv + +## Ausgabe hinzufügen + +### (0. Vorraussetzungen) + +- Linux oder WSL mit Git, Git LFS, GhostScript und ImageMagick ([dieses](https://stackoverflow.com/a/59193253) Problem beachten) +- Schreibzugriff auf dieses Repo + +### 1. `data.json` aktualisieren + +In `assets/data.json` die relevanten Daten der Ausgabe einfügen. + +### 2. PDF hinzufügen + +Um ein PDF hinzuzufügen, `scripts/add_pdf.sh` ausführen und bei Nachfrage gleich änderungen commiten. Beispiel: + +``` +scripts/add_pdf.sh ~/Downloads/hs_ausgabe81.pdf hertzschlag 81 +``` + +(Ist nen Bash script, also nur auf Linux/OSX/WSL) + +### 3. Änderungen pushen + +Mit `git push` Änderungen pushen, die Website sollte über Vercel automatisch aktualisiert werden.