diff --git a/README.md b/README.md new file mode 100644 index 0000000..61643d3 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +[![pipelinestatus](https://gitlab.com/kranklyboy/beyond-uninvited-guests/badges/master/pipeline.svg)](https://gitlab.com/kranklyboy/beyond-uninvited-guests/commits/master) + +# Voraussetzungen + +Um das Latex Dokument kompilieren zu können muss ein TeX System installiert +sein: + +* [TeX Live](https://www.tug.org/texlive/) für Unix Systeme +* [MiKTeX](https://miktex.org/) für Windows Systeme + +Ich bitte darum eine maximale Zeilenlänge von 80 Zeichen einzuhalten, da das +das Arbeiten mit git um ein Vielfaches einfacher macht (unter vim mit `set +tw=79` macht er ab 80 Zeichen automatisch eine neue Zeile). + +# Kompilieren + +Das Projekt kann entweder mit dem Command `make` (muss installiert sein) oder +manuell mit `pdflatex main.tex; bibtex main; pdflatex main.tex; pdflatex +main.tex` kompiliert werden. + +Bei jedem commit wird außerdem ein Job gestartet, der automatisch das Projekt +kompiliert. Das fertige PDF kann dann unter `CI/CD -> Jobs -> passed -> Browse` +eingesehen werden.