cv-boilerplate/README.md

# CV/Résumé Boilerplate

This little project should ease the pain of building and maintaining a CV or résumé using LaTeX.

Since I find writing LaTeX code tedious and error-prone, I keep the actual content of the CV in a yaml file for easier editing and updating, while the layout lives in a separate TeX file. The amazing [pandoc](http://pandoc.org/) takes then care of wrapping everything together and compiling the PDF through LaTeX.

This repository contains a modified version of Dario Taraborelli's [cvtex](https://github.com/dartar/cvtex) template. The original is targeted to academics and scientist, while this one should be flexible enough for everyone.

Below a preview of the final result. Check out the [output](output.pdf) to see the compiled PDF.

![preview](preview.jpg)

## Dependencies

1. LaTeX with the following extra packages: `fontspec` `geometry` `multicol` `xunicode` `xltxtra` `marginnote` `sectsty` `ulem` `hyperref` `polyglossia`
2. pandoc

To install LaTeX on Mac OS X, I recommend getting the smaller version BasicTeX from [here](https://tug.org/mactex/morepackages.html) and installing the additional packages with `tlmgr` afterwards. Same goes for Linux: install `texlive-base` with your package manager and add the needed additional packages later.

To install pandoc on Mac OS X, run `brew install pandoc`. To install it on Linux, refer to the [official docs](http://pandoc.org/installing.html).

## Getting started

Edit `content.yml` with your personal details, work experience, education, and desired settings. Run `make` to compile the PDF. Tweak on `template.tex` until you're satisfied with the result.

Refer to [pandoc's documentation](http://pandoc.org/demo/example9/templates.html) to learn more about how templates work.

Note: this template needs to be compiled with XeTeX.

## Available settings

- **`mainfont`**: Hoefler Text is the default, but every font installed in your system should work out of the box
- **`fontsize`**: Possible values here are 10pt, 11pt and 12pt.
- **`lang`**: Sets the main language through the `polyglossia` package. This is important for proper hyphenation, among other things.
- **`geometry`**: Sets the margins through `geometry`. Read [this](https://www.sharelatex.com/learn/Page_size_and_margins) to learn how this package works.

## Recommended reading

- [Why I do my résumé in LaTeX](http://www.toofishes.net/blog/why-i-do-my-resume-latex/) by Dan McGee
- [What are the benefits of writing resumes in TeX/LaTeX?](http://tex.stackexchange.com/questions/11955/what-are-the-benefits-of-writing-resumes-in-tex-latex) on TeX Stack Exchange
- [Typesetting your academic CV in LaTeX](http://nitens.org/taraborelli/cvtex) by Dario Taraborelli
- [Résumé advices](http://practicaltypography.com/resumes.html) from Butterick's Practical Typography 

## License

[CC BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/)
Add extra packages list and link to the output 2015-10-21 13:37:58 +00:00			`# CV/Résumé Boilerplate`
First commit 2015-10-21 13:21:43 +00:00
Better project description 2015-10-21 15:38:20 +00:00			`This little project should ease the pain of building and maintaining a CV or résumé using LaTeX.`

Update README.md 2015-10-21 19:08:29 +00:00			`Since I find writing LaTeX code tedious and error-prone, I keep the actual content of the CV in a yaml file for easier editing and updating, while the layout lives in a separate TeX file. The amazing [pandoc](http://pandoc.org/) takes then care of wrapping everything together and compiling the PDF through LaTeX.`
First commit 2015-10-21 13:21:43 +00:00
Update README.md 2015-10-21 16:35:03 +00:00			`This repository contains a modified version of Dario Taraborelli's [cvtex](https://github.com/dartar/cvtex) template. The original is targeted to academics and scientist, while this one should be flexible enough for everyone.`
First commit 2015-10-21 13:21:43 +00:00
Update README.md 2015-10-21 22:04:21 +00:00			`Below a preview of the final result. Check out the [output](output.pdf) to see the compiled PDF.`
Add extra packages list and link to the output 2015-10-21 13:37:58 +00:00
Add jpg preview 2015-10-21 22:00:30 +00:00			`![preview](preview.jpg)`

First commit 2015-10-21 13:21:43 +00:00			`## Dependencies`

Update settings and dependencies with poliyglossia 2015-10-22 13:29:08 +00:00			1. LaTeX with the following extra packages: `fontspec` `geometry` `multicol` `xunicode` `xltxtra` `marginnote` `sectsty` `ulem` `hyperref` `polyglossia`
First commit 2015-10-21 13:21:43 +00:00			`2. pandoc`

Add extra packages list and link to the output 2015-10-21 13:37:58 +00:00			To install LaTeX on Mac OS X, I recommend getting the smaller version BasicTeX from [here](https://tug.org/mactex/morepackages.html) and installing the additional packages with `tlmgr` afterwards. Same goes for Linux: install `texlive-base` with your package manager and add the needed additional packages later.
First commit 2015-10-21 13:21:43 +00:00
			To install pandoc on Mac OS X, run `brew install pandoc`. To install it on Linux, refer to the [official docs](http://pandoc.org/installing.html).

			`## Getting started`

			Edit `content.yml` with your personal details, work experience, education, and desired settings. Run `make` to compile the PDF. Tweak on `template.tex` until you're satisfied with the result.

			`Refer to [pandoc's documentation](http://pandoc.org/demo/example9/templates.html) to learn more about how templates work.`

			`Note: this template needs to be compiled with XeTeX.`

Add extra packages list and link to the output 2015-10-21 13:37:58 +00:00			`## Available settings`

Update settings and dependencies with poliyglossia 2015-10-22 13:29:08 +00:00			- `mainfont`: Hoefler Text is the default, but every font installed in your system should work out of the box
Update README.md 2015-10-21 16:18:23 +00:00			- `fontsize`: Possible values here are 10pt, 11pt and 12pt.
Update settings and dependencies with poliyglossia 2015-10-22 13:29:08 +00:00			- `lang`: Sets the main language through the `polyglossia` package. This is important for proper hyphenation, among other things.
			- `geometry`: Sets the margins through `geometry`. Read [this](https://www.sharelatex.com/learn/Page_size_and_margins) to learn how this package works.
Add extra packages list and link to the output 2015-10-21 13:37:58 +00:00
First commit 2015-10-21 13:21:43 +00:00			`## Recommended reading`

Update README.md 2015-10-21 16:35:03 +00:00			`- [Why I do my résumé in LaTeX](http://www.toofishes.net/blog/why-i-do-my-resume-latex/) by Dan McGee`
			`- [What are the benefits of writing resumes in TeX/LaTeX?](http://tex.stackexchange.com/questions/11955/what-are-the-benefits-of-writing-resumes-in-tex-latex) on TeX Stack Exchange`
			`- [Typesetting your academic CV in LaTeX](http://nitens.org/taraborelli/cvtex) by Dario Taraborelli`
First commit 2015-10-21 13:21:43 +00:00			`- [Résumé advices](http://practicaltypography.com/resumes.html) from Butterick's Practical Typography`

			`## License`

			`[CC BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/)`