commit 2ea19ae15dd760e5d7738d0db09421ed4af10396 parent a630f0e01e8cfa0a4089c89800a4ef9effa449a6 Author: Markus Hanetzok <markus@hanetzok.net> Date: Sun, 14 May 2023 02:36:50 +0200 Update README Diffstat:
| D | README | | | 35 | ----------------------------------- |
| A | README.md | | | 32 | ++++++++++++++++++++++++++++++++ |
2 files changed, 32 insertions(+), 35 deletions(-)
diff --git a/README b/README @@ -1,35 +0,0 @@ -Wochenbericht LaTeX-Template -============================ -LaTeX Vorlage zum Erstellen von Wochenberichten inklusive Hilfsskript. - - -Abhängigkeiten --------------- -Folgende Programme werden zum Ausführen des Helferskripts benötigt: - -- dialog -- pdflatex (siehe https://wiki.archlinux.org/title/TeX_Live) -- vipe (in moreutils enthalten) - - -Anwendung ---------- -Das Helferskript kann durch folgenden Befehl aufgerufen werden: - - - cd /Pfad/zum/Skript - chmod +x wochenbericht.sh - ./wochenbericht.sh - -Nach der Abfrage der grundlegenden Daten öffnet sich der Standardeditor um -die Inhalte der einzelnen Rubriken einzutragen. - -(`vipe` nutzt dazu die `$EDITOR` Umgebungsvariable) - - -Anpassung ---------- -Der Pfad zur Template Datei und zum Ausgabeverzeichnis können direkt im Skript -mit den Variablen `tex_dir` und `out_dir` angepasst werden. -Wenn eine andere TeX-Distro genutzt werden soll kann die `tex_cmd` Funktion -angespasst werden. diff --git a/README.md b/README.md @@ -0,0 +1,32 @@ +# Wochenbericht LaTeX-Template +LaTeX Vorlage zum Erstellen von Wochenberichten inklusive Hilfsskript. + + +## Abhängigkeiten +Folgende Programme werden zum Ausführen des Helferskripts benötigt: + +* [dialog](https://man.archlinux.org/man/dialog.1.en) +* [pdflatex](https://wiki.archlinux.org/title/TeX_Live) +* [vipe](https://man.archlinux.org/man/community/moreutils/vipe.1.en) + + +## Anwendung +Das Helferskript kann durch folgenden Befehl aufgerufen werden: + +``` +cd /Pfad/zum/Skript +chmod +x wochenbericht.sh +./wochenbericht.sh +``` + +Nach der Abfrage der grundlegenden Daten öffnet sich der Standardeditor um +die Inhalte der einzelnen Rubriken einzutragen. + +(`vipe` nutzt dazu die `$EDITOR` Umgebungsvariable) + + +## Anpassung +Der Pfad zur Template Datei und zum Ausgabeverzeichnis können direkt im Skript +mit den Variablen `tex_dir` und `out_dir` angepasst werden. +Wenn eine andere TeX-Distro genutzt werden soll kann die `tex_cmd` Funktion +angespasst werden.