leonetienne/LaTeX-Paper-template
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update 'readme.md'

Browse Source
This commit is contained in:
Leon Etienne 2022-05-06 14:35:03 +02:00
parent 14d9c95f12
commit f57d98f933
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md
View File

@ -1,14 +1,22 @@
## To build the document:
1) `make`
---
> Note: When a path in this readme begins with `/`, it is relative to the project root.
## Nomenclature
* 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/`
See example files in these directories...
## Literature
Literature goes in `/dexes/literature.bib`. See examples in this file.
## Literature
# Other stuff worth noting
* All paths must be relative to project root! (where the Makefile lies). When a path in this readme begins with `/`, it is relative to the project root.
* All paths 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`.