loshmi/cv-boilerplate
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Clearer Getting started

Browse Source
This commit is contained in:
zool 2015-10-24 18:25:02 +02:00
parent dc53e31916
commit 61ba20863f
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -52,7 +52,9 @@ To install pandoc on Mac OS X, run `brew install pandoc`. To install it on Linux
## 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.
1. Edit `content.yml` with your personal details, work experience, education, and desired settings.
2. Run `make` to compile the PDF.
3. 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.
@ -60,7 +62,7 @@ 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 (thanks, XeTeX!).
- **`mainfont`**: Hoefler Text is the default, but every font installed in your system should work out of the box (thanks, XeTeX!)
- **`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`**: A string that sets the margins through `geometry`. Read [this](https://www.sharelatex.com/learn/Page_size_and_margins) to learn how this package works.