diff --git a/README.md b/README.md index a9dd0d972b0347058c6e9276d89828e57fb6d629..3d1f37505b8c008a79a0f6d01d038b78304be8ee 100644 --- a/README.md +++ b/README.md @@ -23,29 +23,47 @@ some additional commands. You can find the full documentation of all features in [src/HsH-classes.pdf](src/HsH-classes.pdf), but here is a short description of the different classes: -### `HsH-article` +<dl> + <dt><code>HsH-article</code></dt> + <dd> + Based on the `scrartcl` this class is designed for quick and compact documents. It does + not have chapters and therefore never breaks to a new page on its own. This class is + useful for writing lab-protocols and alike. + </dd> + + <dt><code>HsH-report</code></dt> + <dd> + This is probably the most useful class. It is based on the `scrreprt` and can be used + for a wide variety of documents, beginning with lab-reports and ending at complete + thesis. The line between article and report is somewhat blurry, so use as you see fit. + </dd> + + <dt><code>HsH-book</code></dt> + <dd> + // ToDo has no been required up to this point + </dd> + + <dt><code>HsH-beamer</code></dt> + <dd> + // ToDo may be interesting, but also not requried up to now + </dd> + + <dt><code>HsH-standalone</code></dt> + <dd> + A helper class based on the normal `standalone` class. It is designed only for creating + images as separate documents to keep things organized and compiler times low. It is + useful for creating graphs, circuit diagrams or other kind of complex sub documents. + </dd> +</dl> -Based on the `scrartcl` this class is designed for quick and compact documents. It does -not have chapters and therefore never breaks to a new page on its own. This class is -useful for writing lab-protocols and alike. - -### `HsH-report` - -This is probably the most useful class. It is based on the `scrreprt` and can be used -for a wide variety of documents, beginning with lab-reports and ending at complete -thesis. The line between article and report is somewhat blurry, so use as you see fit. - -### `HsH-book` - -// ToDo - -### `HsH-standalone` +# Quick start guide -A helper class based on the normal `standalone` class. It is designed only for creating -images as separate documents to keep things organized and compiler times low. It is -useful for creating graphs, circuit diagrams or other kind of complex sub documents. +## I have now Idea how to start, show me -# Quick start guide +To get you started, there is a working example Project on the example branch that has +loads of tips. Check it out +[Online](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/tree/example) or +locally using `git checkout example`. ## Recommended software @@ -107,13 +125,6 @@ git push > keep the default name of `master`, but as the template also has a `master` branch it is > less confusing if you choose a different name. -## I have now Idea how to start, show me - -To get you started, there is a working example Project on the example branch that has -loads of tips. Check it out -[Online](https://lab.it.hs-hannover.de/qxx-tul-u1/latex-template-hsh/-/tree/example) or -locally using `git checkout example`. - ## Compiling The Project comes with setting for `latexmk`, so you should be able to instantly compile