* A LaTeX distribution (I recommend MacTex on OSX an MikTex on Windows)
* 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)
If you encounter issues, please make sure everything is in your `PATH`.
### Setup on OSX
* Install a LaTeX distribution, like MacTex (https://tug.org/mactex/). Make sure the bin directory is in your `PATH`.
* Python is already installed, you just need the pygments package:
Make sure they are in your `PATH`.
pip install pygments
* Perl is already installed, nothing to do.
You can also use Homebrew to install more recent versions of Python and Perl.
### Setup on Windows
TODO
### Setup on Linux
TODO
Getting started
---------------
...
...
@@ -28,3 +61,38 @@ Getting started
biber report
pdflatex -shell-escape report
pdflatex -shell-escape report
Contribute
----------
Do not hesitate to make a pull request if you have useful additions/corrections for this template. You can also post an issue if you find a bug or want to suggest an improvement.
The following contributions would be greatly appreciated:
* Dependencies setup guide for Windows & Linux, and precisions for OSX
* Makefile to simplify the build process from the command line
* Internationalization (especially French support)
Special thanks
--------------
I'd like to thank Sylvain Julmy for sharing his template (which I used as a base for my title page) and his precious advice on LaTeX.
License
-------
Copyright 2015 Marc Demierre
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
