initial commit

README.md

@@ -1,3 +1,34 @@
 # Folien
 
-Foliensätze für Cryptoparties, Workshops u.ä.
+Foliensätze für Cryptoparties, Workshops u.ä.
+
+## Mitarbeiten
+
+### Branch-Struktur
+
+Das Repository hat einen `main`-Branch der stets die aktuelle Version der Folien enthält. Der `main`-Branch ist 
+geschützt, das heißt es kann nicht direkt auf den `main`-Branch gepusht werden. Änderungen können wie folgt 
+vorgenommen werden:
+
+- Erstelle einen neuen Branch mit einem sprechenden Namen (z.B. `neue-folien`) und wechsle auf diesen Branch
+- Mache deine Änderungen
+- Pushe deine Änderungen zum Git-Server
+- Erstelle einen Pull-Request von deinem Branch zum `main`-Branch
+- Benachrichtige eine andere Person aus der Gruppe, damit sie deinen Pull-Request prüft und ggf. merged
+
+### Ordner-Struktur
+
+Das Repository hat die folgende Struktur:
+
+```
+- index.html -- Startseite mit Übersicht über alle Foliensätze
+- [mein-thema] -- enthält Foliensatz zum jeweiligen Thema
+    - index.html -- HTML-Datei für Anzeige der Folien
+    - index.md -- Markdown-Datei mit Inhalt der Folien
+- _template -- enthält das Template für neue Foliensätze
+```
+
+### Namens-Konvention
+
+Der Name des Ordners sollte das Thema des Foliensatzes in 1-3 Worten beschreiben. Der Name sollte klein geschrieben 
+werden und Worte werden durch Minuszeichen getrennt, z.B. "verschluesselung-mit-gpg".