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:29:51 +02:00
parent 0f815c1be1
commit 14d9c95f12
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
readme.md
View File

@ -1,13 +1,14 @@
## To build the document:
1) `./compile.sh`, duh. Depends on pdflatex, bibtex, and miktex
1) `make`
## 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...
# Other stuff worth noting
* All paths must be relative to project root! (where `/compile.sh` lies).
* 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.
* 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`.