From c4d343c8d00f26437fdf6c86caec4a058497bd89 Mon Sep 17 00:00:00 2001
From: teridax <sven.vogel123@web.de>
Date: Fri, 15 Sep 2023 16:01:33 +0200
Subject: [PATCH] updated comments and readme

---
 .gitignore |  2 ++
 .latexmkrc | 23 ++++++++++++++++++++++-
 README.md  | 22 +++++++++++++++++++++-
 3 files changed, 45 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 750dcd0..d212ee4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -316,5 +316,7 @@ TSWLatexianTemp*
 # ignore generated pdf file
 main.pdf
 
+# ignore build directories
+# these hold all the clutter we do not want to have 
 tmp
 build
\ No newline at end of file
diff --git a/.latexmkrc b/.latexmkrc
index 0af5cad..398277b 100644
--- a/.latexmkrc
+++ b/.latexmkrc
@@ -1,6 +1,19 @@
-# make file for latex
+# =====================================================================
+# Custom latex make file to bew used with TexLive and Latexmk
+#  _       _            __  __ _  ______   ____ 
+# | | __ _| |_ _____  _|  \/  | |/ /  _ \ / ___|
+# | |/ _` | __/ _ \ \/ / |\/| | ' /| |_) | |    
+# | | (_| | ||  __/>  <| |  | | . \|  _ <| |___ 
+# |_|\__,_|\__\___/_/\_\_|  |_|_|\_\_| \_\\____|
+
+# main file to compile
+# this is the entry point file
 @default_files = ('main.tex');
 
+# =====================================================================
+# custom folders to store auxilary and build files inside
+# so they don't clutter everything
+
 # Move all axuiliary files to a separate directory, so they do not clutter up the project directory
 $emulate_aux = 1;
 $aux_dir = "tmp";
@@ -8,8 +21,12 @@ $aux_dir = "tmp";
 # Move the compiled files (and synctex) to a separate directory
 $out_dir = 'build';
 
+# command to compile and run
 $pdflatex = 'pdflatex %O -interaction=nonstopmode -shell-escape %S';
 
+# =====================================================================
+# bibtex
+
 # Specify the bibliography
 $bibtex = 'bibtex %O %B';
 $makeglossaries = 'makeglossaries %O %B';
@@ -28,6 +45,9 @@ $pdf_mode = 1;
 # Keep auxiliary files
 $clean_ext = " ";
 
+# =====================================================================
+# custom dependency handling for glossaries
+
 add_cus_dep( 'acn', 'acr', 0, 'makeglossaries' );
 add_cus_dep( 'glo', 'gls', 0, 'makeglossaries' );
 $clean_ext .= " acr acn alg glo gls glg";
@@ -39,5 +59,6 @@ sub makeglossaries {
     return system "makeglossaries", "-d", $path, $base_name; 
 }
 
+# =====================================================================
 # Silence warnings
 $silent = 1;
\ No newline at end of file
diff --git a/README.md b/README.md
index dab1b1f..b31298f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
 # Praxisbericht-Template
 
-latex template for writing practial exams and reports for DHBW and ABB
\ No newline at end of file
+Latex template for writing practial exams and reports for DHBW and ABB with TexLive.
+
+## Structure
+
+The template is structured in the following way: Every logical part of the code is contained within a specific directory. The file `main.tex` is the root of the document and is not meant to be modified execpt for adding new packages to be used.
+The directories are as follows:
+
+
+| Direcory   | Contents                                                                                                                                                          |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| chapter    | Holds every chapter page of the report. These pages are to be created by the author on demand.                                                                    |
+| config     | Holds configuration files for metadata about the author, company and topic covered. The data specified will be used automatically throughout the entire document. |
+| extra      | Extra files for utilities and applied fixes                                                                                                                       |
+| multimedia | Stores multimedia files used in the document such als images, videos and pdf files                                                                                |
+| pages      | these are the abstract layout pages of the document are not to be altered                                                                                         |
+
+Acronyms are defined in the file `acros.tex`. Likewise, glossaries are all defined in `glossary.tex`.
+
+## Build
+
+The project is intended to be build by TexLive through the use of latexmk. This is why there is a custom `.latexmkrc` file specified to keep the build process clean.