From a87427662c11db42e7245797dcf6ab4e72795717 Mon Sep 17 00:00:00 2001
From: marius <henker.mr@gmail.com>
Date: Sun, 29 Jun 2025 21:58:37 +0200
Subject: [PATCH] Add sensible README

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..20f05b7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# definitely-not-dhsndd
+
+An unofficial template for a thesis or research paper at the DHSN Dresden.
+
+The Template is designed after the current guideline for scientific papers by the DHSN Dresden (Version 2017).
+
+Examples are under `examples/`.
+
+Use it using a global show rule like so:
+
+```typst
+#show: dhsn.with(
+  topic: "Thema der Arbeit", // Topic and title of the paper
+  subtitle: [Art der Arbeit],
+  // Kind of the paper (ex. "Belegarbeit im 2. Semester").
+  // Look up the specific template description for a bachelorthesis!
+  group: "0XY99-0", // Your tutor group
+  company-data: [Praxispartner GmbH \ 01234 Stadt], // The address/contact of your training company
+  author: "Maxi Musterfrau", // Your full legal name, multiple authors are not supported at the moment.
+  location: "Dresden",
+  // this should almost always be "Dresden"
+  // when using this template because you are submitting it for DHSN in Dresden
+  consultants: ( // List of consultants names
+    (
+        gender: "M",
+        // possible values: "M" (male), "F" (female).
+        // This only changes the Description from "Gutachter" to
+        // "Gutachterin". When gender is left empty,
+        // a gender neutral form is displayed instead.
+        name: "Person Eins", // Full name of your consultant
+    ),
+    (
+        gender: "F",
+        name: "Person Zwei",
+    ),
+  ),
+  assignment-date: datetime.today(), // The assignment date in the typst datetime format
+  submission-date: datetime.today(), // The submission date in the typst datetime format
+  bib: bibliography("my_sources.bib"), // The bibliography (in typst bib format, see bibliography() docs)
+) 
+
+```
+
+Currently supported typst features:
+
+- Headings
+- Blocks of Text
+- Bibliography and citation
+- Figures
+    - Code examples
+    - Images
+    - Tables
+    - other Graphics (ex. using cetz module)
+
+## How to cite
+
+The guideline requires to use footnotes with a prose citation. To do this effectively use the following Syntax:
+
+```typst
+
+This content is taken out of a book #footnote[Vgl. @booklabel]
+
+This content is taken out of another book #footnote[Vgl. #cite(<anotherbook>), S. 15]
+
+````