From ab25f44b58c826d4301c72839d82314b82e76beb Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Mon, 25 Aug 2025 11:49:42 +0200 Subject: [PATCH] docs: Update README --- README.md | 50 +++++++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 29a97f8..0fdead1 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,26 @@ The following sections currently exist: Sections in the main body or sidebar can be reordered at will. -## Advanced experience settings +Any individual entry can be hidden by adding a simple `hidden: true` to the relevant YAML entry +(works for all sections). + +A simple example education entry: + +```yaml +education: + - place: + de: Universität der Welt, Planet Erde + en: University of the World, Planet Earth + title: + de: Globale Friedensstiftung, MA + en: Global Peace Foundations, MA + date: + de: 2016 + en: 2016 + hidden: false +``` + +## Advanced experience presentation settings The experience section has 3 forms: @@ -41,27 +60,12 @@ These options are intended especially for self-employed / entrepreneurial CVs. They let you subdivide your work experience whichever way works best, and additionally divide work undertaken for your own employ or salaried positions for example. -TODO: +## Data-driven uses -- [x] move double-resume sources (per langauge) to a variable or similar -- [x] separate volunteering from skills section -- [_] one function per skill section -- [_] resume prep: - - [ ] make experience groupable by client / short version - - [ ] enable display/hiding of sections/entries by tags? +Since the CV _data_ is separated from the CV _presentation_, it is possible to create different +presentations for the same underlying data structures. -- [x] migrate to typst template? -- [x] ! Fix german summary to be like English summary -- [_] generalized entry? - Would have 'title', 'place', 'date', 'type'/'tags' + potential - 'publication', 'bullets' - -## Typst-driven branch - -- [x] Fix publication '\&'s -- [x] Fix en-dash/em-dash (e.g. in years) -- [x] Producable from yaml content -- [x] Can be switched between Ger/En -- [x] Try sidebar version - - [ ] Generalize sidebar version through abstraction/extractions -- [x] unify items: experience/education/(thesis?) +One fun example is my self-presentation as a Linux [manual page](https://martyoeh.me/blog/2025-05-11-manpage-resume). +Other, more reasonable, uses are encouraged, such as presentation embedded within an HTML page, +different print and screen-reading documents, +or short calling cards.