From e0f9bcaf0772d8e502e7bae65b5285d8c6922c66 Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Thu, 19 May 2022 12:15:37 +0200 Subject: [PATCH] Readme --- ...x-cheat-sheet.tex => latex-cheat-sheet.tex | 0 readme.md | 24 +++++++++++++++---- 2 files changed, 19 insertions(+), 5 deletions(-) rename chapters/latex-cheat-sheet.tex => latex-cheat-sheet.tex (100%) diff --git a/chapters/latex-cheat-sheet.tex b/latex-cheat-sheet.tex similarity index 100% rename from chapters/latex-cheat-sheet.tex rename to latex-cheat-sheet.tex diff --git a/readme.md b/readme.md index 4a62fde..b05f772 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,17 @@ -# LaTeX-Paper-template +# LaTeX-Praxisbericht template > Note: When a path in this readme begins with `/`, it is relative to the project root. -This is a small framework/template/starting point for scientific LaTeX papers in german. +This is a starting point to write a Praxisbericht according to the University of applied Sciences, Worms's guidelines. +When first starting out, your very first stop should be to get it to compile. +Once it does, adjust `/config.tex` to fit your specific environment (your name, your partner business, etc... just a bunch of variables). +Then, go through the files in `/chapters`, and put in your own redactory work. + +## Dependencies +* node.js +* pageres-cli (installed via npm) +* texlive-full +* bibtex +* make ## To build the document: 1) `make` @@ -11,18 +21,22 @@ This is a small framework/template/starting point for scientific LaTeX papers in * 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... +See example files in these directories... +The glossary and acronym dex is disabled by default. It can be re-activated in `/main.tex`. ## Literature Literature goes in `/dexes/literature.bib`. See examples in this file. ## LaTeX syntax -You'll find a basic LaTeX cheat sheet in`/chapters/foobar.tex`. +You'll find a basic LaTeX cheat sheet in`/latex-cheat-sheet.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. +## Studienübersicht-Table +You can configure your studienübersicht-table 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). * 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`. +