Added description on how to compile the document

This commit is contained in:
Dennis Potter 2018-11-12 17:20:33 +01:00
parent dd9aca2734
commit f753837305

View File

@ -1,5 +1,16 @@
## Setup
Add this to `~/.latexmkrc`:
## Prerequisites & setup
The compilation of this master's thesis was only verified on Linux. The following software is required to compile this work:
* A LaTeX compiler, for example, [TeX Live](https://tug.org/texlive/) for Linux
* [latexmk](https://www.ctan.org/pkg/latexmk/) is assumed by all build automation
* [LibreOffice](https://www.libreoffice.org/) is used to transform the OpenDocument drawings to PDFs
* [Python >3.7](https://www.python.org/) is required to generate tables in the appendix and to automatically generate graphs. Furthermore, the following Python packages are required:
* [jupyter notebook](https://jupyter.org/)
* [pandoc](https://pandoc.org/)
* [matplotlib](https://matplotlib.org/)
* [numpy](http://www.numpy.org/)
In order to be able to generate the list of abbrevations, the following has to be added to to `~/.latexmkrc`:
```bash
add_cus_dep('acn', 'acr', 0, 'makeacn2acr');
sub makeacn2acr {