From a4ce581b7d982a02ddaa43313bfb3cc92df814f9 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Thu, 2 Dec 2021 19:04:53 +0200 Subject: [PATCH] README.md: actually describe the project Resolves: #36 Resolves: #37 --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a63f29d..fe85417 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -Work In Progress - https://mikaela.info/cv +# CV on Jekyll/markdown + +* [Live version](https://mikaela.info/cv/) + +This CV is inpired by [Carolyn Stransky's Creating a digital CV in Markdown on GitHub](https://workwithcarolyn.com/blog/digital-cv-guide) +and intented to *contain everything* and be source for *copy-pasting to CVs +actually sent* to parties interested in CV/resume. The smaller version will +likely be generated with [EuroPass](http://europass.cedefop.europa.eu/documents/curriculum-vitae). + +## To-do, issues, feedback etc. + +* [GitHub issues](https://github.com/Mikaela/cv/issues) +* [GitHub discussions](https://github.com/Mikaela/cv/discussions/) + +## Versioning + +Due to having two different language versions, I need to be aware which state +particular version is to keep them in sync, I have decided to use [CalVer](https://calver.org/) +format `YYYY.0W.MICRO` (year.week.numberofEdit e.g. `2022.01.00`). + +Additionally more human readable date is provided for convenience of the +reader for when I have made changes or confirmed the CV to still be +up-to-date. + +Internally both of these are provided in the YAML front matter and refer to +variable on the bottom of the page.