26 lines
1.3 KiB
Markdown
Raw Normal View History

2022-01-02 15:19:25 +01:00
## To build the document:
2022-05-06 14:29:51 +02:00
1) `make`
2022-01-02 15:19:25 +01:00
2022-05-06 14:35:03 +02:00
---
> Note: When a path in this readme begins with `/`, it is relative to the project root.
2022-01-02 15:19:25 +01:00
## Nomenclature
2022-02-03 14:18:12 +01:00
* All your text should go into `/chapters/`.
* All your indices, such as acronyms, references, glossary entrys, if not generated automatically, should go into `/dexes/`
* All your appendix pages should go into `/appendix/`
2022-05-06 14:29:51 +02:00
See example files in these directories...
2022-01-02 15:19:25 +01:00
2022-05-06 14:35:03 +02:00
## Literature
Literature goes in `/dexes/literature.bib`. See examples in this file.
2022-05-09 20:24:29 +02:00
## LaTeX syntax
You'll find a basic LaTeX cheat sheet in`/chapters/foobar.tex`.
A way more extensive (but also deviating from this workflow) paper is `/abschlussarbeit_mit_latex.pdf`, which is targetted towards writing german scientific papers with LaTeX, with some weird IDE on windblows OS. So take that with a grain of salt.
2022-05-06 14:35:03 +02:00
2022-01-02 15:19:25 +01:00
# Other stuff worth noting
2022-05-09 20:24:29 +02:00
* All paths (like when referencing an image, or including a `.tex`) must always be relative to project root! (where the Makefile lies).
2022-02-03 14:18:12 +01:00
* Configure your projects base informations such as title, author, year, etc in `/config.tex`.
* When creating new chapters (files in `/chapters/`), you have to include them in `/chapters.tex`.
2022-02-03 14:19:12 +01:00
* When creating new appendix entries (files in `/appendix/`), you have to include them in `/appendix.tex`.