From 5b1120db6885de861dd8d8afb36791fe774b5f1a Mon Sep 17 00:00:00 2001 From: Charles N Wyble Date: Fri, 13 Dec 2024 16:26:15 -0600 Subject: [PATCH] v1.2 docs... --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 824083c..895805c 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ # MarkdownResume-Pipeline-ClientExample -Example client repository for using the [MarkdownResume-Pipeline](https://git.knownelement.com/reachableceo/MarkdownResume-Pipeline) vendored repository. +Example client repository for using the [MarkdownResume-Pipeline](https://git.knownelement.com/reachableceo/MarkdownResume-Pipeline) resume building +microservice. The microservice is vendored into this repository. ## Quickstart -I recommend doing these steps in order for efficency. +### Runtime Requirements -- Edit local/build/build-resume.sh and edit the values in the top section to refelct your information. -- Edit local/Templates/WorkHistory/WorkHistory.csv -- Create local/Templates/JobHistoryDetails/.md to match the value in the first field of WorkHistory.csv -- Edit local/Templates/SkillsAndProjects/Projects.md -- Edit local/Template/SkillsAndProjects/Skills.csv -- Edit local/Templates/CandidateInfoSheet.md -- cd to the local/build directory and run bash build-resume.sh +- Bash (this entire project was developed on msys2 on Windows 10) +- Ensure you have pandoc installed and in your path. + +### Steps + +- Edit local/build/CandidateVariables.env to refelct your information. +- Edit local/Templates/MarkdownResume/WorkHistory/WorkHistory.csv +- Create and edit local/Templates/MarkdownResume/JobHistoryDetails/.md to match the value in the first field of WorkHistory.csv +- Repeat as necessary for your job history. +- Edit local/Templates/MarkdownResume/SkillsAndProjects/Projects.md +- Edit local/Template/MarkdownResume/SkillsAndProjects/Skills.csv +- Edit local/Templates/MarkdownResume/CandidateInfoSheet.md +- cd to the local/build directory and run bash build-demo-markdown.sh +- Examine the PDF/MSWord output in local/build-output/*