diff --git a/README.md b/README.md index bd5f581c427b084227fa62c42dd9a7e84e7a33db..2a684eae154e10159b46dfeaa634d371edbed221 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ - # WZL Latex + *Template, requirements, tools & tricks* + *Contact:* Amon Göppert (gpp) + **Info** This is an examplary LaTeX project with .tex and .bib files as a template for writing final reports, theses or dissertations in WZL style. The formatting rules and parameters are located in the `WZLtemplate.cls` file, which is designed according to the @@ -10,17 +12,22 @@ The formatting rules and parameters are located in the `WZLtemplate.cls` file, ## Getting started ### Requirements + **Online TeX-System & IDE** + For a fully integrated web-based TeX and IDE system check-out: [Overleaf](https://www.overleaf.com/) The master branch of this repository is pushed to this public Overleaf project: [wzl-latex project](https://www.overleaf.com/read/ydwhkjfbhksc) Disadvantages of overleaf are the necessary figure and literature uploads. Advantages are the out-of-the-box usage withouth required software installations described in the following. + **TeX system** + For compiling .tex-files locally, a TeX-System is required. Install one of the following, based on your OS: * Windows/Linux: [TeX Live](https://www.tug.org/texlive/) * Mac: [MacTeX](http://www.tug.org/mactex/) **IDE** + For proper .tex-files editing an IDE is needed. Install one of the following: * [Texstudio](https://www.texstudio.org/) (recommended) * [Texmaker](https://www.xm1math.net/texmaker/) @@ -36,6 +43,7 @@ Clone with tls/https (requires an ssh-configuration for the connection of your l The Deckblattundformularlogoverwendung PDF might not be included properly, due to the PDF input fields. Please fill in your data in a PDF editor, then print as PDF (this will remove the input fields). Then you can add the new PDF, containing your information, in `02_documents` under the filename `deckblattundformularlogoverwendung.pdf`. ### Document options + In `main.tex`, several different options can be selected: - **Language**: the options are `de` or `en` - **Font**: choosing `sans` will result in a Sans serif font (like Arial), not putting any option results in a Serif font. @@ -45,6 +53,8 @@ In `main.tex`, several different options can be selected: - `authoryearcite`: Citation of the form "(Hevner, March, Park and Ram 2004)". - `footnotecite`: Citation in a footnote, includes the author, year and title, e.g. "Hevner, March, Park and Ram, Design Science in Information Systems Research, 2004." + +### Further possibilities Compile the main.tex-file with your IDE and consider the resulting PDF for further explanations. ## Helpful tools