diff --git a/README.md b/README.md index a568c84..c619b01 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,10 @@ To install pandoc on Mac OS X, run `brew install pandoc`. To install it on Linux **Note**: this template needs to be compiled with XeTeX. +**Note for Windows users**: although I didn't tested it, you can probably use this boilerplate on Windows, too. Both [Pandoc](http://pandoc.org/installing.html) and LaTeX can be installed on Windows (I recommend [MikTeX](http://miktex.org/) for that) and you should be able to run makefiles on Windows through [Cygwin](https://www.cygwin.com/). If that's too much hassle, this command should do the trick in Powershell: + + pandoc details.yml -o output.pdf --template=template.tex --latex-engine=xelatex + ## Available settings - **`mainfont`**: Hoefler Text is the default, but every font installed on your system should work out of the box (thanks, XeTeX!)