https://github.com/oresttokovenko/latex-resume-workflow
Automated workflow for creating, organizing, and maintaining your job application resumes using LaTeX
https://github.com/oresttokovenko/latex-resume-workflow
automation bash latex makefile python resume workflow xelatex
Last synced: 4 months ago
JSON representation
Automated workflow for creating, organizing, and maintaining your job application resumes using LaTeX
- Host: GitHub
- URL: https://github.com/oresttokovenko/latex-resume-workflow
- Owner: oresttokovenko
- License: mit
- Archived: true
- Created: 2023-06-25T04:40:29.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-13T22:22:49.000Z (almost 2 years ago)
- Last Synced: 2025-01-16T06:14:34.178Z (5 months ago)
- Topics: automation, bash, latex, makefile, python, resume, workflow, xelatex
- Language: TeX
- Homepage: https://www.oresttokovenko.com/blog/latex-workflow
- Size: 74.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Resume Workflow
This project provides an automated workflow for creating, organizing, and maintaining your job application resumes using LaTeX. It uses a combination of Make, Bash, and Python scripts to set up a smooth and consistent resume creation process.
## Features
This workflow includes several key features, which are implemented through make recipes. These recipes are distributed across two different versions of Makefiles in this project. If you're unsure of which make recipes you can run, check with `make help`
- `make new-resume`: Prompts for a company name and job title, then sets up everything you need to create a LaTeX resume
- `make compile`: Compiles your LaTeX resume using XeLaTeX
- `make final-pdf`: Renames and moves the output file to a higher directory
- `make links`: Generates the LinkedIn URL and website/blog/portfolio URL that every job application typically asks for
- Handles existing job or job/company combinations gracefully
## Prerequisites
To use this workflow, you need the following installed on your machine:
- VS Code
- Note: This workflow is designed with VS Code in mind. However, you can make this requirement redundant by replacing instances of the word `code` in the `create_resume_files.sh` script with the command to open your preferred text editor
- A LaTeX distribution that contains the XeLaTeX compiler
- Python version 3.7 or higher
- A PDF viewer integrated into your test editor. This is necessary to view the compiled LaTeX files efficiently. If you're using VS Code, an [extension like PDF Viewer](https://marketplace.visualstudio.com/items?itemName=tomoki1207.pdf) can be used. It supports hot reloading, which allows the PDF to refresh automatically when changes are made to the source file.
### Installing LaTeX
You can install LaTeX using Homebrew with the following command:
```bash
brew install --cask mactex-no-gui
```
### Installing sample resume font
If you intend on running the LaTeX code in the `sample_company` directory , you'll need to install Gyre TeX fonts:
```bash
curl "https://mirror.quantum5.ca/CTAN/fonts/tex-gyre.zip" --output ~/Downloads/tex-gyre.zip
```
## Getting Started
Once you have cloned this project, you need to update the following:
- `resume_file_name` variable in `_helpers/create_final_resume_pdf.sh`
- `linkedin_link_url` and `website_name` variables in `_helpers/print_links.py`
- `dir` variable in `_helpers/Makefile`
You can also search for all variables associated with a `# NOTE: update this` comment to identify variables that require updating.
## Example Workflow
1. In the root directory, run `make new-resume`. If successful, a new directory will be created in the file explorer and three files should open automatically
2. Paste the command that was copied to your clipboard into the terminal and run it. This command will navigate you to the correct folder in your new directory and allow you to take advantage of the LaTeX compilation related make recipes
3. Open the `job_description.txt` file and paste the job description for the position you're applying for. This will help you tailor your resume to the specific role and keep track of the job requirements
4. If you haven't set up default resume TeX files to be copied into each new folder, then copy and paste your TeX code into the `main.tex` file. If you're using one of the provided templates (such as the one in the sample directory), you will also need to paste code into the `resume_config.cls` file
5. Run `make compile` to compile your resume. You can view the output by opening the `main.pdf` file. If you are not able to generate a pdf file, run `make compile-log` instead to see the LaTeX output log and attempt to locate the source of the error
6. Once you are satisfied with your resume, run `make final-pdf`. This command will save your resume using the proper naming convention and export it to a directory one level higher in order to separate it from the other files
By following these steps, you can efficiently create, compile, and export your resumes