commit d69f759d2122f03168fbeda0c5603b754dd5e8b6 parent 50fc4bd73720e6f767247bc1279ad0a9f09527f2 Author: Markus Hanetzok <markus@hanetzok.net> Date: Fri, 8 Sep 2023 12:15:11 +0200 make README plain text again Diffstat:
| A | README | | | 34 | ++++++++++++++++++++++++++++++++++ |
| D | README.md | | | 32 | -------------------------------- |
2 files changed, 34 insertions(+), 32 deletions(-)
diff --git a/README b/README @@ -0,0 +1,34 @@ +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. diff --git a/README.md b/README.md @@ -1,32 +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](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.