Alicia Sykes - CV

This repo contains the source for my personal CV
🌐 cv.aliciasykes.com | 📄 Alicia-Sykes-CV.pdf

Motivation
Why spend 30 minutes writing your CV, when you could spend 30 hours automating it?

The resume content is defined in resume.yml following the jsonresume.org standard, and validated against schema.json. A LaTex document is then generated from template.jinja formated with resume-format.cls, which is then compiled into a PDF by GitHub Actions, and published under the Releases tab. A markdown version is also generated by lib/markdown.py, as well as a CV website which is built as a static Svelte site and deployed to GitHub Pages at cv.aliciasykes.com

---

Usage

Option #1 - GitHub

Upon creating a tag (by triggering the Tag Workflow), a new Release will be drafted with your compiled CV PDF attatched

1. Fork the repo
2. Update resume.json with your own content
3. Trigger the GitHub Action to compile the PDF

Workflows

• tag - Creates a new Git tag. Optionally specify the tag name and description, or by default it will just bump the sem ver patch number by 1
• generate - Generates your resume in PDF form as an artifact. If triggered by a tag, then a new release will be created, with the PDF attatched
• validate - Validates your resume data against the schema. This will also run whenever a new PR is opened, to ensure it's valid and working

---

Option #2 - Local

See the Makefile for all the available commands. Or, just run make from the root, to install deps, validate content, generate LaTex, and compile PDF

1. Clone the repo
2. Update resume.json with your own content
3. Run make from the root, to install deps, validate content, generate LaTex, and compile PDF

Commands

• make install - Download dependencies
• make validate - Validate content
• make generate - Generate LaTex
• make compile - Compile PDF
• make clean - Remove generated files
• make watch - Watch for changes, recompile and refresh

---

Editing

Modify data by editing resume.yml
If you need to customize the layout, edit template.jinja
Or to change the styles and formatting, edit resume-format.cls
All the scripts used to generate output are located in lib/
These are triggered either by the Makefile or via GitHub Actions with the workflows/
The source for the website version is located in web/

---

Attributions

Contributors

Sponsors

---

License

Lissy93/CV is licensed under MIT © Alicia Sykes 2024.
^{For information, see TLDR Legal > MIT}

Expand License

The MIT License (MIT)
Copyright (c) Alicia Sykes <[email protected]> 

Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal 
in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell 
copies of the Software, and to permit persons to whom the Software is furnished 
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included install 
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

© Alicia Sykes 2024
Licensed under MIT

^{Thanks for visiting :)}