53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# Vorraussetzungen
|
|
Damit die Dokumentation korrekt compiliert, müssen zwei Vorraussetzungen erfüllt sein:
|
|
1. Eine LaTeX distribution (MiKTeX, TeX Live, MacTeX)
|
|
2. Ein entsprechender githook um den aktuellen commit hash korrekt in das Dokument übernehmen zu können.
|
|
|
|
## LaTeX Distributionen
|
|
- [MiKTeX](https://miktex.org/)
|
|
- [TeXLive](https://www.tug.org/texlive/)
|
|
- [MacTeX](https://www.tug.org/texlive/)
|
|
|
|
## Git hook
|
|
Eine Datei mit dem Namen `post-checkout` im Ordner `.git\hooks` mit folgendem Inhalt erstellen:
|
|
```shell
|
|
#!/bin/sh
|
|
# Copyright 2015 Brent Longborough
|
|
# Part of gitinfo2 package Version 2
|
|
# Release 2.0.7 2015-11-22
|
|
# Please read gitinfo2.pdf for licencing and other details
|
|
# -----------------------------------------------------
|
|
# Post-{commit,checkout,merge} hook for the gitinfo2 package
|
|
#
|
|
# Get the first tag found in the history from the current HEAD
|
|
FIRSTTAG=$(git describe --tags --always --dirty='-*' 2>/dev/null)
|
|
# Get the first tag in history that looks like a Release
|
|
RELTAG=$(git describe --tags --long --always --dirty='-*' --match '[0-9]*.*' 2>/dev/null)
|
|
# Hoover up the metadata
|
|
git --no-pager log -1 --date=short --decorate=short \
|
|
--pretty=format:"\usepackage[%
|
|
shash={%h},
|
|
lhash={%H},
|
|
authname={%an},
|
|
authemail={%ae},
|
|
authsdate={%ad},
|
|
authidate={%ai},
|
|
authudate={%at},
|
|
commname={%cn},
|
|
commemail={%ce},
|
|
commsdate={%cd},
|
|
commidate={%ci},
|
|
commudate={%ct},
|
|
refnames={%d},
|
|
firsttagdescribe={$FIRSTTAG},
|
|
reltag={$RELTAG}
|
|
]{gitexinfo}" HEAD > .git/gitHeadInfo.gin
|
|
|
|
```
|
|
|
|
# Build
|
|
Wenn alle Vorraussetzungen erfüllt sind, kann das dokument mit folgendem Befehl erstellt werden:
|
|
```shell
|
|
pdflatex fat.tex
|
|
```
|
|
Beim ersten erstellen, kann es sein, dass der Befehl mehrfach ausgeführt werden muss, damit das inhaltsverzeichnis und alle Referenzen korrekt bestimmt werden können. |