From 61ba20863fe665a748f2416ac69293fdaad14e0d Mon Sep 17 00:00:00 2001 From: zool Date: Sat, 24 Oct 2015 18:25:02 +0200 Subject: [PATCH] Clearer Getting started --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96941b5..3cf5ac8 100644 --- a/README.md +++ b/README.md @@ -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.