=======
LICENSE
=======
Henri Menke
2013 Universität Stuttgart.
Dieses Werk ist unter einer Creative Commons Lizenz vom Typ Namensnennung -
Nicht-kommerziell - Weitergabe unter gleichen Bedingungen 3.0 Deutschland
zugänglich. Um eine Kopie dieser Lizenz einzusehen, konsultieren Sie
http://creativecommons.org/licenses/by-nc-sa/3.0/de/ oder wenden Sie sich
brieflich an Creative Commons, 444 Castro Street, Suite 900, Mountain View,
California, 94041, USA.
=========
COMPILING
=========
Compile by using:
> latexmk
or using
> arara main.tex
> arara main-booklet.tex
If you are editing the source code and you don't want the Makefile to rebuild
the index and the bibliography use
> pdflatex {FILE}.tex
or setup your favourite LaTeX-Editor and use your keyboard shortcuts.
Building in dvi-mode will fail, due to the microtype package.
Building was tested with TeXlive 2013.
===========
DEVELOPMENT
===========
This is a guide for people who want to contribute.
To do so please respect the following coding rules:
1. "DO NOT EDIT THIS FILE":
---------------------------
Do not edit files containing the "DO NOT EDIT THIS FILE" header.
Pull requests containing changes to these files will be ignored.
2. Indentation:
---------------
Indent your code by one tab in the first level. Deeper levels get indented
by additional tabs, of course.
3. Usage of \\:
---------------
Never use \\ inside of your text! Only use it when you have to (e.g. in
tables, equations). To begin a new paragraph just insert a blank line.
4. Code structure:
------------------
To make code more readable but to avoid randomly inserted space make use of
the % character. Use this on all equation-environments. Example:
Some text followed by an equation
%
\begin{equation}
a^2 + b^2 = c^2
\end{equation}
%
Some more text.
5. Don't commit garbage files:
------------------------------
To not commit any files created by your favourite LaTeX-Editor, do a
> latexmk -c
before committing.
6. Never commit something you can't compile:
--------------------------------------------
This rule is pretty obvious, but there are still people out there ignoring this.
If your edits don't compile on your machine don't dare to send a pull request.