Skip to content

Commit d3598c1

Browse files
committed
Update README.md to include formatting instructions for LaTeX files
1 parent 528585b commit d3598c1

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,29 @@ Das Makefile stellt die folgenden Befehle bereit:
1414
make clean - räumt mit allen temporären Dateien auf
1515
make dir - erstellt das Vorkurs-Verzeichnis
1616
make nodir - löscht das Vorkurs-Verzeichnis
17-
make zip - erstellt ein zip-file um es online zu stellen
17+
make zip - erstellt ein zip-file um es online zu stellen
18+
make format - formatiert alle Latex files automatisch (siehe section Formatierung)
19+
20+
Formatierung
21+
------------
22+
23+
Mit
24+
25+
make format
26+
27+
werden alle `.tex`-Dateien im Projekt automatisch mit `latexindent` formatiert. Dabei werden eventuell fehlende Perl-Module erkannt und du kannst auswählen, ob sie automatisch installiert werden sollen. Nach dem Formatieren werden alle von `latexindent` erzeugten Backup-Dateien (z.B. `.bak0`) automatisch entfernt.
28+
29+
**Voraussetzungen:**
30+
- `latexindent.pl` muss installiert sein (enthalten in TeX Live oder MacTeX).
31+
- Die Perl-Module `YAML::Tiny`, `File::HomeDir`, `Unicode::GCString` und `File::Find::Rule` müssen installiert sein (das Skript hilft bei der Installation).
32+
- Für die automatische Installation der Module kann ggf. `sudo` benötigt werden.
33+
34+
**Ablauf:**
35+
1. `make format` ausführen.
36+
2. Fehlende Module werden angezeigt und können installiert werden.
37+
3. Alle `.tex`-Dateien werden formatiert.
38+
4. Backup-Dateien werden entfernt.
39+
1840

1941
Skript
2042
------

0 commit comments

Comments
 (0)