From 4ea715d02d5ede0981f8e54387545a6d04cea6ef Mon Sep 17 00:00:00 2001
From: L3D <l3d@c3woc.de>
Date: Tue, 23 Apr 2024 21:05:30 +0200
Subject: [PATCH] Create Example and explain Options

---
 README.md  | 90 +++++++++++++++++++++++++++++++++++++++++++++++-------
 example.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 166 insertions(+), 11 deletions(-)
 create mode 100644 example.md

diff --git a/README.md b/README.md
index 883fda8..f271068 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,83 @@
-# pandoc-moderncv
+# Pandoc Template - Lebenslauf
 
-Pandoc Template um einen Lebenslauf mit dem LaTex Paket [moderncv](https://ctan.org/pkg/moderncv) zu gestalten
+Pandoc Template um einen Lebenslauf mit dem LaTex Paket [moderncv](https://ctan.org/pkg/moderncv) zu gestalten und relativ Easy aus einem Markdown File zu befüttern.
 
-<WORK IN PROGRESS/>
+## Beispiel
+Siehe ``example.md``
+```bash
+pandoc example.md -o example.pdf --template=moderncv.tex
+```
 
-Requirements:
-  - pandoc
-  - texlive
-  - texlive-latex-extra
-  - texlive-extra-utils
-  - texlive-fonts-extra
-  - texlive-lang-german
+## Abhängigkeiten
+Unter Debian werden folgende Programme benötigt, um das Template zu verwenden:
+```bash
+sudo apt install pandoc texlive \
+  texlive-latex-extra texlive-extra-utils \
+  texlive-fonts-extra texlive-lang-german
+```
 
-License: CC-BY-NC L3D <l3d@c3woc.de>
+## Variabeln
+| Name | Optional/default | Beschreibung |
+| --- | --- | --- |
+| ``moderncvcolor`` | ``black`` | black, blue, burgundy, green, grey, orange, purple oder red |
+| ``vorname`` | \* | Vorname |
+| ``name`` | \* | Familienname |
+| ``street`` | \* | Straße |
+| ``place`` | \* | Ort |
+| ``phone`` | - | Telefonnummer |
+| ``mail`` | - | Mailadresse |
+| ``resumetitle`` | - | Überschrift des Lebenslauf |
+| ``born`` | - | Geburtsdatum |
+| ``homepage`` | - | Homepage |
+| ``xing`` | - | Xing Username |
+| ``github`` | - | Link zum Github Profil |
+| ``xtradetail`` | - | About me - Freitextfeld |
+| ``quote`` | - | Zitat |
+| ``erfahrung: []`` | - | Liste mit Erfahrungen |
+| → ``date`` | \* | Datum |
+| → ``job`` | \* | Tätigkeit |
+| → ``company`` | | Firma der Tätigkeit |
+| → ``place`` | - | Ort der Tätigkeit |
+| → ``skills: [] | - | Liste der erlernten Skills, Erfahrungen etc... |
+| →→ ``label`` | - | Skillname |
+| →→ ``note`` | | Ausgeübter Skill, Erfahrung... |
+| ``ausbildung: []`` | - | (schulische) Ausbildung |
+| → ``date`` | \* | Zeit der Ausbildung |
+| → ``degree`` | - | Abschluss |
+| → ``school`` | \* | Bildungseinrichtung |
+| → ``place`` | - | Ort der Ausbildung |
+| ``itkenntnisse: []`` | - | Besondere Kenntnisse - IT-Kenntnisse |
+| → ``name`` | \* | Was? |
+| → ``detail`` | - | Details |
+| ``projekte: []`` | - | Private Projekte |
+| → ``name`` | \* | Was? |
+| → ``detail`` | - | Details |
+| ``sprachen: []`` | - | Sprachkenntnisse |
+| → ``sprache`` | \* | Sprache |
+| → ``skill`` | - | Sprachskill |
+| ``konferenz: []`` | - | besuchte Konferenzen |
+| → ``date`` | \* | Datum der Konferenz |
+| → ``name`` | \* | Name der Konferenz |
+| → ``wikipedia`` | - | Wikipedialink |
+| → ``www`` | - | Weblink |
+| ``engagement: []`` | - | Soziales Engagement |
+| → ``date`` | \* | Datum |
+| → ``group`` | \* | |
+| → ``place`` | | |
+| → ``detail`` | - | |
+| → ``skill`` | - | |
+| ``hobbies: []`` | - | Liste der Hobbys |
+| → ``name`` | | Hobby |
+| ``skill: []`` | - | Skill Matrix |
+| ``skillname`` | - | Überschrift Skill Matrix |
+| → ``type`` | - | Kategorie des Skill |
+| → ``level`` | \* | Skilllevel |
+| → ``name`` | \* | Fähigkeit |
+| → ``experience`` | \* | Jahr des Erstkontakt |
+| → ``experience`` | - | Kommentar |
+| ``zeugnisse: []`` | List der Angehängten Zeugnisse |
+| → ``name`` | \* | Name des Zeugnis |
+| → ``file`` | \* | Zeugnis-PDF (keine Leerzeichen, Bindestriche etc. im Filename) |
+
+## License
++ CC-BY-NC L3D <l3d@c3woc.de>
diff --git a/example.md b/example.md
new file mode 100644
index 0000000..abe769d
--- /dev/null
+++ b/example.md
@@ -0,0 +1,87 @@
+---
+# Personal information
+vorname: 'Max'
+name: 'Muster'
+street: "Musterstr. 1"
+place: "12345 Musterstadt"
+mail: "mmuster@example.com"
+born: '1. Januar 1970'
+
+# Web
+homepage: 'https://example.org'
+github: "github.com/do1jlr"
+xtradetail: 'Cyber-Influencer'
+quote: 'Cyber Cyber'
+
+# Resume Details
+resumetitle: "Bewerbung als Cyberexperte"
+moderncvcolor: 'blue'
+
+# Job Experience
+erfahrung:
+  - date: '1984 -- \the\year'
+    job: 'Cyberexperte'
+    company: 'CYBER Comapany'
+    place: 'Cyberspace'
+    skills:
+      - label: 'Tätigkeiten:'
+        note: 'Cybern und sonstiges Cyber'
+      - note: 'Cyber *Cyber*…'
+  - date: '1970 - 1984'
+    job: 'Examplejob'
+    company: 'Surveillance Inc.'
+    place: 'Cyberspace'
+
+# schulische Ausbildung und Abschlüsee
+ausbildung:
+  - date: '1965 - 1970'
+    degree: 'Cyberabschluss'
+    school: 'Schule'
+    place: 'Ort der Schule'
+  - date: '1961 - 1965'
+    school: 'Grundschule'
+    place: 'Musterstadt'
+
+# Soziales Engagement
+engagement:
+  - date: '1984 -- \the\year'
+    group: 'Buchclub'
+    detail: 'Something'
+    skill: 'Leser des dystopischer Roman von George Orwell'
+
+konferenz:
+  - date: '1970'
+    name: 'Cyberkonferenz'
+    wikipedia: 'https://wikipedia.org/wiki/Chaos_Communication_Congress'
+    www: 'https://example.org/'
+
+itkenntnisse:
+  - name: 'Betriebssysteme'
+    detail: 'ArchLinux'
+  - name: 'Programmierung'
+    detail: 'LaTeX'
+
+projekte:
+  - name: 'LoRaWAN'
+    detail: 'Sensorendaten über LoRaWAN übermitteln.'
+
+sprachen:
+  - sprache: 'Deutsch'
+    skill: 'Muttersprache'
+  - sprache: 'Englisch'
+    skill: 'fließend'
+
+hobbies:
+  - name: 'Pandoc Templates aus dem Internet runterladen'
+
+skill:
+  - type: 'IT'
+    level: '5'
+    name: 'Foo'
+    experience: '1970'
+  - type: 'IT'
+    level: '4'
+    name: 'Bar'
+    experience: '1984'
+    comment: ''
+---