Le support aux utilisateurs et les demandes de création de comptes externes doivent être faites depuis les issues du projet GitLab HEFR (https://gitlab.forge.hefr.ch/forge-hefr/gitlab-hefr)

README.md 3.58 KB
Newer Older
Marc Demierre's avatar
Marc Demierre committed
1
2
3
HEIA project report LaTeX template
==================================

Marc Demierre's avatar
Marc Demierre committed
4
5
A LaTeX template following the HEIA recommendations for project reports.

Marc Demierre's avatar
Marc Demierre committed
6
7
Author: Marc Demierre <marc.demierre@gmail.com>

Marc Demierre's avatar
Marc Demierre committed
8
9
10
11
12
13
14
15
16
17
18
19
Features
--------

* Nice title page with school logo, project info and project logo
* Code highlighting
* Smart cross-references support (using autoref)
* "Abstract" page
* "Authors" page
* Table of contents
* Header and footer with project information
* Glossary (acronyms and terms)
* Bibliography
Marc Demierre's avatar
Marc Demierre committed
20
21
22
23
24


Dependencies
------------

25
* A LaTeX distribution
Marc Demierre's avatar
Marc Demierre committed
26
* biber (for bibliography)
Marc Demierre's avatar
Marc Demierre committed
27
28
29
30
31
32
33
34
35
36
* 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:
Marc Demierre's avatar
Marc Demierre committed
37

Marc Demierre's avatar
Marc Demierre committed
38
39
40
        pip install pygments
    
* Perl is already installed, nothing to do.
Marc Demierre's avatar
Marc Demierre committed
41

Marc Demierre's avatar
Marc Demierre committed
42
43
44
45
You can also use Homebrew to install more recent versions of Python and Perl.

### Setup on Windows

46
* Install a LaTeX distribution, like MiKTeX (http://miktex.org/). Make sure the bin directory is in your `PATH`.
47
* Install the biber package. See http://tex.stackexchange.com/questions/154708/how-can-one-install-biber-on-miktex-64-bit to know how.
48
49
50
51
52
53
* 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)
Marc Demierre's avatar
Marc Demierre committed
54
55
56
57

### Setup on Linux

TODO
Marc Demierre's avatar
Marc Demierre committed
58
59
60
61

Getting started
---------------

Marc Demierre's avatar
Marc Demierre committed
62
63
* Install the dependencies
* Fill your project details in `config/metadata.tex`
64
65
66

### Using the command line

Marc Demierre's avatar
Marc Demierre committed
67
68
* Build using the following commands:

Marc Demierre's avatar
Marc Demierre committed
69
70
71
72
73
        pdflatex -shell-escape main
        makeglossaries main
        biber main
        pdflatex -shell-escape main
        pdflatex -shell-escape main
74
75
76
77
78
79
        
### 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
Marc Demierre's avatar
Marc Demierre committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96


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
--------------

Marc Demierre's avatar
Marc Demierre committed
97
98
99
100
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
* Damien Raemy, for his tests on the Windows platform
Marc Demierre's avatar
Marc Demierre committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

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
    limitations under the License.