From 7670e448b217bc96d13c08312dc666e3d0a9a7a6 Mon Sep 17 00:00:00 2001
From: Yannik Enss <me@adnidor.de>
Date: Thu, 12 Nov 2020 15:02:05 +0100
Subject: [PATCH] Add README

---
 README.rst | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.rst

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..44859fa
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,41 @@
+FSR Generator
+=============
+
+Diese Sammlung an Skripten kann die meisten Dinge die man so für einen FSR braucht erzeugen.
+
+How to configure
+----------------
+
+In `generator.conf` die Dateipfade überprüfen, ausserdem für jeden FSR die Werte für Redeleitung und Protokoll anpassen. Wenn die `read_*`-Skripte genutzt werden sollen müssen dort auf Werte angepasst werden.
+
+How to use
+----------
+
+Immer
++++++
+
+Die aktuelle TOP-Mails raussuchen und in eine mbox schreiben deren Pfad in `generator.conf` angegeben ist.
+
+Einladung
++++++++++
+
+`./generate.py --invite --write-mbox`
+
+Die mbox im Mailclient öffnen, die neuste Nachricht auswählen, "als neu bearbeiten", absenden.
+
+Präsentation
+++++++++++++
+
+`./prepare-presentation.sh`
+
+Jetzt liegt unter `data/presentation_[date].tex` eine LaTeX-Beamer-Präsentation. Im idealfall kann man die direkt mit pdflatex o.ä. kompilieren und hat dann eine fertige Präsentation, oft muss man aber die LaTeX-Datei manuell anpassen.
+
+Protokoll
++++++++++
+
+`./read_ubmails.py`
+
+`./read_uvproto.sh`
+
+`./generate.py --protocol > somewhere`
+