diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..42062e882f57656d0efe470017c9e01c945434c8 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# LaTeX-Vorlage für Abschlussarbeiten + +Dies ist die Vorlage für Bachelor- oder Masterarbeiten +des Lehrstuhls für Softwaretechnik und Programmiersprachen. + +## Dateien + +Sie finden in diesem Repository folgende `.tex`-Dateien vor: + +- `thesis.tex`: + Dies ist die Hauptdatei der Arbeit, + welche zur finalen PDF kompiliert. + In dieser Datei geben Sie Ihren Namen und die Daten zu Ihrer Arbeit an. +- `content.tex`: + Diese Datei enthält den textlichen Inhalt der Vorlage. + Im Rahmen Ihrer schriftlichen Ausarbeitung ist es sinnvoll, + einzelne Abschnitte in ihre eigenen Dateien auszulagern. +- `abstract.tex`: + Enthält die maximal einseitige Zusammenfassung Ihrer Arbeit. +- `acknowledgements.tex`: + Falls Sie Danksagungen in Ihrer Arbeit aussprechen wollen, + so schreiben Sie sie in diese Datei. +- `appendix.tex`: + Ähnlich zur `contents.tex`; + enthält sämtlichen eventuellen Anhang zu Ihrer Arbeit. +- `references.bib`: + Enthält die BibTeX-Einträge Ihrer verwendeten Quellen. + +## Makefile + +Der Vorlage liegt ein `Makefile` bei. +Über das Terminal können Sie somit folgende Kommandos aufrufen: + +```bash +# Baut die PDF +make + +# Löscht alle generierten LaTeX-Dateien (inklusive PDF) +make clean + +# Sortiert die BibTeX-Einträge und sorgt für einheitliche Formatierung +make bibtool + +# Baut die PDF aus den Sourcen stetig neu und updated die Anzeige +# in Ihrem PDF-Betrachter +make watch +``` + +Das Makefile nutzt hierbei `latexmk`, +welches entsprechend auf Ihrem System zur Verfügung stehen muss.