reachableceo/MarkdownResume-Pipeline-ClientExample
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

v1.2 docs...

Browse Source
This commit is contained in:
Charles N Wyble 2024-12-13 16:26:15 -06:00
parent 4d17933dd9
commit 5b1120db68
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -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/<position>.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/<position>.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/*