diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ae180c..5b0eaef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,8 +15,6 @@ Suche zunächst nach ähnlichen Issues, bevor du ein neues erstellst. Vergewisse Errata und grundlegende Klarstellungen werden akzeptiert, sofern wir der Meinung sind, dass sie den Inhalt verbessern. Du kannst auch ein Issue eröffnen, damit wir besprechen können, wie oder ob das Problem behoben werden sollte. -Falls du so etwas noch nie gemacht hast, könnte der [Flow-Leitfaden](https://docs.github.com/de/get-started/quickstart/github-flow) hilfreich sein. - ## Größere Überarbeitungen Bitte eröffne vor umfangreicheren Änderungen zunächst ein Issue zur Diskussion. @@ -35,6 +33,4 @@ Für das einfachere Bearbeiten der Inhalte stellen wir ein [VSCode-Plugin](https ## Zeichnungen -Die Zeichnungen werden durch LaTeX und TikZ umgesetzt. Hierbei kommt insbesondere die Bibliothek [CircuiTikZ](https://ctan.org/pkg/circuitikz?lang=de) zum Einsatz. Ein direktes Modifizieren der SVG-Dateien ist für die deutschen Inhalte nicht vorgesehen! - -Das Python-Skript `src/build_drawings.py` wird verwendet, um ein neues Bild zu erstellen. Beim Aufrufen des Skripts muss eine Bildnummer eingegeben werden. Die Bildnummern müssen aufsteigend vergeben werden: Bitte hierzu vorher ein Issue öffnen. Außerdem ist es notwendig, dass das Programm *pdftocairo* installiert ist, um ein SVG zu generieren. +Die Zeichnungen werden durch LaTeX und TikZ umgesetzt. Alle Informationen findet man dieser [README](src/README.md). diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..a977d18 --- /dev/null +++ b/src/README.md @@ -0,0 +1,7 @@ +# Zeichnen von Vektorgrafiken + +Die Zeichnungen werden durch LaTeX und TikZ umgesetzt. In der Regel ist immer die neueste LaTeX-Version erforderlich. Außerdem kommt insbesondere die Bibliothek [CircuiTikZ](https://ctan.org/pkg/circuitikz?lang=de) zum Einsatz. Ein direktes Modifizieren der SVG-Dateien ist für die Inhalte nicht vorgesehen! Außerdem ist es notwendig, dass das Programm *pdftocairo* installiert ist, um aus dem von LaTeX erzeugten PDF ein SVG zu generieren. + +Das Python-Skript `src/build_drawings.py` wird verwendet, um ein neues Bild zu erstellen. Beim Aufrufen des Skripts muss eine Bildnummer eingegeben werden. Die Bildnummern müssen aufsteigend vergeben werden: Bitte hierzu vorher ein Issue öffnen. Weiterhin ist die Breite des Bildes optional anzugeben. Der Standardwert liegt bei 9 cm. Bei manchen Grafiken kann es sinnvoll sein, eine kleinere Breite zu wählen. + +Bitte vor dem Zeichnen eines neuen Bildes einen Issue öffnen um Missverständnisse zu vermeiden. \ No newline at end of file