Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
LaTeX Template HsH
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Jan Wille
LaTeX Template HsH
Commits
dd97fa05
Commit
dd97fa05
authored
1 year ago
by
Jan Wille
Browse files
Options
Downloads
Patches
Plain Diff
README: use definition list
parent
ba5722bf
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+38
-27
38 additions, 27 deletions
README.md
with
38 additions
and
27 deletions
README.md
+
38
−
27
View file @
dd97fa05
...
...
@@ -23,30 +23,48 @@ 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>
### `HsH-report`
<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>
### `HsH-book`
// ToDo
<dt><code>
HsH-book
</code></dt>
<dd>
// ToDo has no been required up to this point
</dd>
### `HsH-standalone`
<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>
# Quick start guide
## 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`
.
## Recommended software
As a Tex-Distribution,
[
MiKTeX is recommended
](
https://miktex.org/
)
, TexLive should also
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment