From 14d9c95f128d47d44d449e1a16e02c1b7b3ab2b3 Mon Sep 17 00:00:00 2001 From: Leon Etienne Date: Fri, 6 May 2022 14:29:51 +0200 Subject: [PATCH] Update 'readme.md' --- readme.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 9b21b39..d444b46 100644 --- a/readme.md +++ b/readme.md @@ -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`.