diff --git a/README.md b/README.md index 0466da7..88058b4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,71 @@ -# Praxisbericht-Template-Typst -The template makes use of ABB and DHBW branding. +
+ +# DHBW-ABB Typst template + +**Unofficial** but feature rich **Typst** template for writing a thesis or report at DHBW with according ABB AG branding in mind. + + + + + + + +
+ + +
+ +## Features + +> ⚠️ **Notice**
+> Typst ist under active development and thus may lack features an experienced LaTeX is used to. + +This template includes designs for a titlepage, confidantiality statement, declaration of authorship and more with a consistent design inspired by various unofficial works made by students at DHBW. Layout and the choise fonts are based on the unofficial [supercharged-dhbw](https://github.com/DannySeidel/typst-dhbw-template) Typst template. It comes with automatic generation of outlines for figures, tables, code snippets and appendices. +The template can generate sections for a glossary, combinging acronyms and technical terms into a singular section. ## Format All pages have a margin of 2.5cm between header/footer/content and the page border. -Header and footer do not overlap into this margin. +Header and footer do not overlap into this margin in order to conform to university requirements. -Bibliography is formated with the IEEE style. Appendecies make use of the APA style. \ No newline at end of file +Bibliography is formated with the IEEE style.
+Appendecies make use of an abbreviation of APA style. + +## Fonts + +Both fonts used in the document are licensed under the [Open Font License](https://openfontlicense.org/) and can be used for non-commercial as well as commercial purposes. They can be downloaded from google fonts: +- [Montserrat](https://fonts.google.com/specimen/Montserrat) +- [Open Sans](https://fonts.google.com/specimen/Open+Sans) + +Consider giving the creators of the font credit for their amazing work! + +## For users jumping over from LaTeX + +The developers around Typst have made pretty handy comparison guide between LaTeX and Typst syntax and features. You can find it [here](https://typst.app/docs/guides/guide-for-latex-users/). + +## Legal + +This template and its content is in no way officially affiliaterd with either DHBW or ABB AG. +Its only purpose is to simplify the process of getting started with the typsetting language Typst for writing a university report or thesis. +As author and owner of the reposity I claim no copyright of the logos used in the document, the software used to compile the source or the documents based on this template. + +## FAQ + +### Why Typst instead of LaTeX? + +LaTeX is quite old. Which does not make it bad just because. But with its age and historically grown way of dealing with pretty much any kind of task - has made LaTeX cumbersome to work with. The syntax is outdated for sure but the most annoying issues (for me personally) are the following: +- long compilation times +- poor documentation of build systems such as `latexmk` +- lots of stuff requires extra programs to be run in between +- page layout is easy to mess up +- HUGE installation size + +Typst in comparison is serval orders of magnitudes faster and has native support for UTF-8. It automatically runs several times to generate the proper layout and links. Additionally being open source and written in Rust it is contained within a single handy binary. + +**TLDR;** I find Typst easier and faster to work with. + +### Where are the logos from? + +The logos for both ABB AG and DHBW are freely available at Wikimedia Commons: +- [ABB logo as svg](https://commons.wikimedia.org/wiki/File:ABB_logo.svg) +- [DHBW logo as svg](https://upload.wikimedia.org/wikipedia/de/1/1d/DHBW-Logo.svg) \ No newline at end of file