diff --git a/CHANGELOG.md b/CHANGELOG.md index 7184c28fc56b7cbbeffdbb04449360198e555a32..8b41415ab927733e8213ec361a99a2458a20cf4a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,35 +2,46 @@ All notable changes to this project will be documented in this file. -## [V 1.1] - 2021-04-22 +## [Current] + +### Fixed +- Issues that came with the Kernel update from 01.06.2021 are fixed (#2, #3, #4) +- typos + +### Added +- defined checklist environment via enumitem-package in `config.tex` +- added required package for enum item + + +## [1.1] - 2021-04-22 This version provides mostly minor fixed and upgrades. -**IMPORTANT:** the personal.tex has been removed +**IMPORTANT:** the `personal.tex` has been removed ### Added - - dtx installer file. All class files can be generated from this file. this removes code duplications and allows for more easy maintenance as well as - deployment. This file will only be available on a separate branche and not be part of the master branch. + - dtx installer file. All class files can be generated from this file. This removes code duplications and allows for more easy maintenance as well as + deployment. This file will only be available on a separate branch and not be part of the master branch. ### Changed - - Makefile has been reworked. should now be more stable and easier to understand - - Titlepage as been improved. You can now align the standart titlepage as you prefer - - the declaration of authorship now uses the proper babel interface for localisation - - License is now LPPL + - Makefile has been reworked. Should now be more stable and easier to understand + - Title page as been improved. You can now align the standard title page as you prefer + - the declaration of authorship now uses the proper babel interface for localization + - Licence is now LPPL ### Removed - - personal.tex has been removed. It pretty much not used anyway. All contents have been moved to the project files preamble. + - `personal.tex` has been removed. It pretty much not used anyway. All contents have been moved to the project files preamble. -## [V 1.0] - 2021-03-31 +## [1.0] - 2021-03-31 Initial Version. Official first release ### Added - HsH-article class - HsH-report class - HsH-standalone class - - config.tex file - - personal.tex file + - `config.tex` file + - `personal.tex` file - folder structure, with readme files for every folder - empty project file - makefile - - example on the example branche \ No newline at end of file + - example on the example branch diff --git a/README.md b/README.md index fc1b834101226b7502ca0dca21c6ed5501d4ed3b..d227f05bab5361949936268232f3c101cf792622 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # What this is This is a template designed to ease the workflow when writing documents for the Hochschule Hannover. It is intended to be used in all sophisticated -works, from lab-reports to masters thesis's. -The project provides custom document-classes caring the `HsH-` prefix as well as support files. These classes extend the well known KOMA-script -classes and customize them them with specific configurations, presets and provide commonly needed features. +works, from lab-reports to master’s thesis's. +The project provides custom document-classes caring the `HsH-` prefix as well as support files. These classes extend the well known KOMA-Script +classes and customize them with specific configurations, presets and provide commonly needed features. **Provided classes are:** @@ -15,9 +15,9 @@ classes and customize them them with specific configurations, presets and provid **Version:** 1.1 **Date:** 21.04.2021 -# License +# Licence -This project is distributed under the LaTeX project public license (LPPL), version 1.3c. +This project is distributed under the LaTeX project public licence (LPPL), version 1.3c. # TODO: diff --git a/bib/README.md b/bib/README.md index 02f60e39fb0b2ae79ae310977ec6f8e1f543eb6d..776169288ea61fd0c6a873a8d213903be641ea88 100644 --- a/bib/README.md +++ b/bib/README.md @@ -1,4 +1,4 @@ -# Bibliograpy folder +# Bibliography folder -This folder is for bibliographic purpises. Here should be `.bib` files for useage with the `biblatex`package and source dokuments like pdfs, -presentations or downloaded web-pages. \ No newline at end of file +This folder is for bibliographic purposes. Here should be `.bib` files for usage with the `biblatex`package and source documents like PDFs, +presentations or downloaded web-pages. diff --git a/chap/README.md b/chap/README.md index 1cf1ae9597e49a3f88709ee14efbbb8552128f3f..3f36c193bdd2618664df111fac921e1c21df61f9 100644 --- a/chap/README.md +++ b/chap/README.md @@ -1,4 +1,4 @@ # Chapters folder -For bigger projects it can be usefull to have separate files for chapters. -These separate files should be stored here and can be included into the main document via `\input{chap/one.tex}`. \ No newline at end of file +For bigger projects it can be useful to have separate files for chapters. +These separate files should be stored here and can be included into the main document via `\input{chap/one.tex}`. diff --git a/crc/README.md b/crc/README.md index c58b4f77452b2dedbb8371d33afd07419b5282fa..bda7a43491236ff7dd0f214100b5a2ba1dd856cc 100644 --- a/crc/README.md +++ b/crc/README.md @@ -1,4 +1,4 @@ # Circuits folder -This folder is for Circuit diagramms. It is recommended to use the `circuitikz` package. This extents the `tikz` package with commands for close to all -your circuit diagramm needs. Have a look at the documentation. \ No newline at end of file +This folder is for Circuit diagrams. It is recommended to use the `circuitikz` package. This extends the `tikz` package with commands for close to all +your circuit diagram needs. Have a look at the documentation. diff --git a/csv/README.md b/csv/README.md index b943f23d558b652f011c73695d9e5f61f592b0e2..61b5bac0bb56d38ba587a61d8ae586128c94fa94 100644 --- a/csv/README.md +++ b/csv/README.md @@ -1,11 +1,11 @@ -# CSV folder (Comma Speeratet Values) +# CSV folder (comma separate values) This folder is for measurement readings and other kinds of data collection. -It is named *csv*, but you could also use different filetypes, even though the `.csv` type is the easiest to include in LaTex. -Keep in mind, that the config selts the ';' as the seperator, which is the german standart +It is named *CSV*, but you could also use different file types, even though the `.csv` type is the easiest to include in LaTeX. +Keep in mind, that the config sets the `;` as the separator, which is the German standard # Export Excel to CSV -Excel ist a gerate tool for collecting and doing calculation on measured data, but is not so good for using that data in other tools. That's why there +Excel is a great tool for collecting and doing calculation on measured data, but is not so good for using that data in other tools. That's why there is a VBA macro, that makes it super easy to export excel-sheets into separate CSV documents, which can be used in Latex and easily reexported on -changes in the excel file. \ No newline at end of file +changes in the Excel file. diff --git a/img/README.md b/img/README.md index d7ac2142d797de43551c588bbede554ffe07e7d7..eec8507e113ec9f7d80ba6654c03479a56b99586 100644 --- a/img/README.md +++ b/img/README.md @@ -1,4 +1,4 @@ # Images folder (pictures) -This folder is for images, this can be pictures,created graphs, sketches or circuit diagramms. It is recommended to work with `.png` and `.pdf` filetypes for inclusion -in the main document, but files needed by the respective editors may also be stored here. +This folder is for images, this can be pictures, created graphs, sketches or circuit diagrams. It is recommended to work with `.png` and `.pdf` file +types for inclusion in the main document, but files needed by the respective editors may also be stored here. diff --git a/plt/README.md b/plt/README.md index a703d4643dc99233ed53d26b8b38736553f3c088..4a48263ef602c8c2532c2c420732c67148cbb553 100644 --- a/plt/README.md +++ b/plt/README.md @@ -1,5 +1,5 @@ # Plots-folder This folder is for plots and graphs. It exists mostly because it is recommended to use the `pgf-plots` package. This huge and powerful package also -brings up the compilertime of a `.tex` file by a lot. That's why it is recommended to create separate files for every plot an just import the resulting -`.pdf` file into the final document, recompiling the graph itself only when needed. \ No newline at end of file +brings up the compiler time of a `.tex` file by a lot. That's why it is recommended to create separate files for every plot a just import the resulting +`.pdf` file into the final document, recompiling the graph itself only when needed. diff --git a/svg/README.md b/svg/README.md index c583c2c979127558be1dd0ef66c11c01f8a537eb..f0c6c42eb8648ea670982dde399cbfa94602e398 100644 --- a/svg/README.md +++ b/svg/README.md @@ -1,9 +1,9 @@ # SVG-Folder -The svg format is widely used for webgraphics and vectorgraphics. This makes it usefull for creating complex graphics and illustrations. +The svg format is widely used for web graphics and vector graphics. This makes it useful for creating complex graphics and illustrations. # Image creation with Inkscape -Inkscape is a amazing vectorgraphics tool with an export to LaTex feature. I highly recommend it for creating complex images like sketches of +Inkscape is an amazing vector graphics tool with an export to LaTeX feature. I highly recommend it for creating complex images like sketches of experimental setup. -Check oute their website: [Inkscape.org](https://inkscape.org/) \ No newline at end of file +Check out their website: [Inkscape.org](https://inkscape.org/)