Improved readme

This commit is contained in:
Leonetienne 2022-05-20 11:31:58 +02:00
parent 265f1b3f85
commit 292648e4ee
No known key found for this signature in database
GPG Key ID: C33879CD92E9708C

View File

@ -22,7 +22,7 @@ Then, go through the files in `/chapters`, and put in your own redactory work.
* 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/`
See example files in these directories...
The glossary and acronym dex is disabled by default. It can be re-activated in `/main.tex`.
The glossary and acronym dex are disabled by default. They can be re-activated in `/main.tex`.
## Literature
Literature goes in `/dexes/literature.bib`. See examples in this file.
@ -30,13 +30,14 @@ Literature goes in `/dexes/literature.bib`. See examples in this file.
## LaTeX syntax
You'll find a basic LaTeX cheat sheet in`/latex-cheat-sheet.tex`.
## Studienübersicht-Table
You can configure your studienübersicht-table in `/studienuebersicht/table.html`.
## Studienübersicht-table
You can configure your studienübersicht-table (the colorful one, showing all your modules) in `/studienuebersicht/table.html`.
You can render it via `make uebersicht-table`, but it should generate automatically, when just running `make`.
# Other stuff worth noting
* All paths (like when referencing an image, or including a `.tex`) must always be relative to project root! (where the Makefile lies).
* All paths (like, when referencing an image, or including a `.tex` file) must always be relative to project root! (where the Makefile lies).
* 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`.
* When creating new appendix entries (files in `/appendix/`), you have to include them in `/appendix.tex`.
* If you have any technical questions regarding this, feel free to [email me](https://www.leonetienne.de/contact.html).