Superminaren/50ohm-contents-dl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: improved CONTRIBUTING.md

Browse Source
This commit is contained in:
Matthias Jung
2026-02-04 23:56:34 +01:00
parent 3579dcada6
commit 7f330f0d3b
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+1 -5
View File
@@ -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. 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. 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 ## Größere Überarbeitungen
Bitte eröffne vor umfangreicheren Änderungen zunächst ein Issue zur Diskussion. 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 ## 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! Die Zeichnungen werden durch LaTeX und TikZ umgesetzt. Alle Informationen findet man dieser [README](src/README.md).
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.
src/README.md
+7
View File
@@ -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.