commit a630f0e01e8cfa0a4089c89800a4ef9effa449a6 parent 61c82b7f176d6cab5e00ff4c5a5bb8196628185a Author: Markus Hanetzok <markus@hanetzok.net> Date: Sat, 18 Mar 2023 21:24:11 +0100 Update README Diffstat:
| A | README | | | 35 | +++++++++++++++++++++++++++++++++++ |
| D | README.md | | | 33 | --------------------------------- |
2 files changed, 35 insertions(+), 33 deletions(-)
diff --git a/README b/README @@ -0,0 +1,35 @@ +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 @@ -1,33 +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 [TeX Live](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.