Curriculum Vitae

Public CV with CI/CD magics to generate and publish PDF

⬆️ Top of Document
🏗️ Requirements
- Arch Linux (BTW™)
- Alpine Linux -- Docker pandoc/extra:3.1.13.0-alpine
⚡ Quick Start
🧰 Usage
🗒 Notes
📈 Contributing
- 🔱 Forking
- 💱 Sponsor
📇 Attribution
⚖️ Licensing

Requirements

Access to GitHub Actions if using on GitHub, or installing the following dependencies if running locally;

Arch Linux (BTW™)

sudo pacman -S texlive-bin \
  texlive-basic \
  texlive-binextra \
  texlive-latex \
  texlive-latexextra \
  texlive-fontsrecommended

sudo texconfig rehash

Alpine Linux -- Docker `pandoc/extra:3.1.13.0-alpine`

tlmgr install ragged2e datetime fmtcount

Quick Start

Follow the Forking instructions
Update the curriculum-vitae.md to reflect your personal/professional skills
Publish to GitHub and/or utilize the scripts/pandoc-md-to-pdf.sh

Usage

Create a new PDF CV from MarkDown source

./scripts/pandoc-md-to-pdf.sh curriculum-vitae.md curriculum-vitae.pdf

Or, overwrite preexisting PDF CV from MarkDown source

CLOBBER=1 ./scripts/pandoc-md-to-pdf.sh curriculum-vitae.md curriculum-vitae.pdf

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

According to some kind recruiters providing feedback, applicant intake automation tends to give-up after reading the first ten pages of a PDF! So it my be a good idea to keep output to less than that, unless you have a diverse background spanning decades ;-P

Contributing

Options for contributing to curriculum-vitae and S0AndS0

Forking

Start making a Fork of this repository to an account that you have write permissions for.

Add remote for fork URL. The URL syntax is [email protected]:<NAME>/<REPO>.git...

cd ~/git/hub/S0AndS0/curriculum-vitae

git remote add fork [email protected]:<NAME>/curriculum-vitae.git

Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/S0AndS0/curriculum-vitae


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

Sponsor

Thanks for even considering it!

Via Liberapay you may on a repeating basis.

Regardless of if you're able to financially support projects such as curriculum-vitae that S0AndS0 maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

Attribution

License

Public CV with CI/CD magics to generate and publish PDF
Copyright (C) 2024 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.

The above licence is applicable to the following files;

.github/README.md
.github/workflows/md-to-pdf.yaml
.github/workflows/pandoc-extended/Dockerfile
scripts/pandoc-md-to-pdf.sh

s0ands0 / curriculum-vitae Goto Github PK