Skip to content
Snippets Groups Projects
Commit 5c0900e2 authored by Marc Demierre's avatar Marc Demierre
Browse files

README update with Windows instructions and TexMaker setup

parent 5acb9bc5
No related branches found
No related tags found
Loading
......@@ -22,7 +22,7 @@ Features
Dependencies
------------
* A LaTeX distribution (I recommend MacTex on OSX an MikTex on Windows)
* A LaTeX distribution
* biber (for bibliography)
* Python 2.7+ or 3+ and pygments (for the minted code highlighting package)
* Perl 5 (a recent version) (for the xindy indexing package)
......@@ -43,7 +43,14 @@ You can also use Homebrew to install more recent versions of Python and Perl.
### Setup on Windows
TODO
* Install a LaTeX distribution, like MiKTeX (http://miktex.org/). Make sure the bin directory is in your `PATH`.
* Install the biber package
* Install Python from https://www.python.org/downloads/windows/. Be sure to check the PATH option in the installer.
* Install the pygments package
pip install pygments
* Install a Perl distribution from https://www.perl.org/get.html#win32 (recommended: ActivePerl)
### Setup on Linux
......@@ -54,13 +61,22 @@ Getting started
* Install the dependencies
* Fill your project details in `config/metadata.tex`
### Using the command line
* Build using the following commands:
pdflatex -shell-escape report
makeglossaries
makeglossaries report
biber report
pdflatex -shell-escape report
pdflatex -shell-escape report
### Using the Texmaker IDE
* Use this configuration for the quick build:
pdflatex -shell-escape -synctex=1 -interaction=nonstopmode %.tex|makeglossaries %|biber %|pdflatex -shell-escape -synctex=1 -interaction=nonstopmode %.tex|pdflatex -shell-escape -synctex=1 -interaction=nonstopmode %.tex
Contribute
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment