README.md 3.29 KB
Newer Older
Florian Walch's avatar
Florian Walch committed
1 2
# LaTeX template for TUM theses

Florian Walch's avatar
Florian Walch committed
3
This is a LaTeX template created according to the guidelines for TUM informatics theses in SS 2013. **Always check the [current formatting guidelines][thesis-guidelines] before you hand in.** See [`build/main.pdf`][sample-pdf] for an example PDF created with this template.
Florian Walch's avatar
Florian Walch committed
4

Florian Walch's avatar
Florian Walch committed
5
Note: Because of copyright considerations, TUM logos are not included in this template and have to be downloaded separately (see instructions below).
Florian Walch's avatar
Florian Walch committed
6 7 8 9 10

Comments & contributions welcome!

## Quickstart

Florian Walch's avatar
Florian Walch committed
11
 * [Download][template-download] and extract the template. If you prefer to use Git, just clone/fork the repository.
Florian Walch's avatar
Florian Walch committed
12 13 14 15
 * Download the TUM logos in PDF format:
   * Log in to [MyTUM][mytum].
   * Download the TUM logo from [here][mytum-logo-tum] and save it to `logos/tum.pdf`.
   * Download your faculty's logo from [here][mytum-logo-faculty] and save it to `logos/faculty.pdf`.
Florian Walch's avatar
Florian Walch committed
16
   * Some logos might not be cropped; execute the `crop-logos` script to do that for you. The script requires the `pdfcrop` tool (included in TeX Live/MiKTeX), so make sure your `PATH` environment variable is set accordingly.
Florian Walch's avatar
Florian Walch committed
17
 * Configure your latex editor to use `pdflatex`, `biber` for bibliography, and `makeglossaries` for glossary generation. Set `main.tex` as the master document. Alternatively, you can use the provided makefile to create a PDF in the `build` directory (requires `latexmk`).
Florian Walch's avatar
Florian Walch committed
18 19
 * Look for `TODO` comments in the provided files. Start at `main.tex`.

Florian Walch's avatar
Florian Walch committed
20
For additional hints, have a look at [the wiki][wiki]. If you still have problems, feel free to [create an issue][issue].
21

Florian Walch's avatar
Florian Walch committed
22 23 24 25
## License

[![Creative Commons License][license-image]][license]

Florian Walch's avatar
Florian Walch committed
26
This template is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License][license], meaning that:
Florian Walch's avatar
Florian Walch committed
27

Florian Walch's avatar
Florian Walch committed
28 29 30 31 32 33 34 35 36 37 38 39 40
 * You can share (copy, redistribute) and adapt (remix, transform, build upon) this template for any purpose, even commercially.
 * If you share the template or a modified (derived) version of it, you must attribute the template to the original authors ([Florian Walch and contributors][template-authors]) by providing a [link to the original template][template-url] and indicate if changes were made.
 * Any derived template has to use the [same][license] or a [compatible license][license-compatible].

 The license **applies only to the template**; there are no restrictions on the resulting PDF file or the contents of your thesis.

[issue]: https://github.com/fwalch/tum-thesis-latex/issues
[license-compatible]: https://creativecommons.org/compatiblelicenses
[license-image]: https://i.creativecommons.org/l/by-sa/4.0/88x31.png
[license]: https://creativecommons.org/licenses/by-sa/4.0/
[mytum-logo-faculty]: https://portal.mytum.de/corporatedesign/download/fakultaetslogos/index_html
[mytum-logo-tum]: https://portal.mytum.de/corporatedesign/download/TUM_Logo/index_html
[mytum]: https://portal.mytum.de
Florian Walch's avatar
Florian Walch committed
41
[sample-pdf]: https://raw.github.com/fwalch/tum-thesis-latex/master/build/main.pdf
Florian Walch's avatar
Florian Walch committed
42
[template-authors]: https://github.com/fwalch/tum-thesis-latex/graphs/contributors
Florian Walch's avatar
Florian Walch committed
43
[template-download]: https://github.com/fwalch/tum-thesis-latex/archive/master.zip
Florian Walch's avatar
Florian Walch committed
44 45
[template-url]: https://github.com/fwalch/tum-thesis-latex
[thesis-guidelines]: http://www.in.tum.de/en/current-students/administrative-matters/thesis-guidelines-and-topics.html
46
[wiki]: https://github.com/fwalch/tum-thesis-latex/wiki/