summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpacien2017-11-28 17:41:56 +0100
committerpacien2017-11-28 18:55:08 +0100
commitac60669cd3a93312f0ff186055e61a5e3fb5fcdd (patch)
treec91dc155449e15101c9187c03c689ac42b88cd43
parentd6b00e0fbda7778ee25cb70ae5beb9fe824d2e69 (diff)
downloadmorpher-ac60669cd3a93312f0ff186055e61a5e3fb5fcdd.tar.gz
Add api-doc and report template + their recipes
Signed-off-by: pacien <pacien.trangirard@pacien.net>
-rw-r--r--doc/api/.gitkeep0
-rw-r--r--doc/project-report.md30
-rw-r--r--doc/report-template.tex732
-rw-r--r--makefile8
4 files changed, 770 insertions, 0 deletions
diff --git a/doc/api/.gitkeep b/doc/api/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/doc/api/.gitkeep
diff --git a/doc/project-report.md b/doc/project-report.md
new file mode 100644
index 0000000..e0339d6
--- /dev/null
+++ b/doc/project-report.md
@@ -0,0 +1,30 @@
1---
2title: "Morphing in C"
3author: [Pacien TRAN-GIRARD, Adam NAILI]
4date: 2017-11-09
5...
6
7# Project description
8
9## Licensing
10
11## Credits
12
13---
14
15# Compilation and usage
16
17## Building the project
18
19## Running the program
20
21---
22
23# Implementation details
24
25## Modules
26
27## Additional features
28
29## Notes
30
diff --git a/doc/report-template.tex b/doc/report-template.tex
new file mode 100644
index 0000000..fc98ced
--- /dev/null
+++ b/doc/report-template.tex
@@ -0,0 +1,732 @@
1%%
2% Copyright (c) 2017, Pascal Wagler;
3% Copyright (c) 2014--2017, John MacFarlane
4%
5% All rights reserved.
6%
7% Redistribution and use in source and binary forms, with or without
8% modification, are permitted provided that the following conditions
9% are met:
10%
11% - Redistributions of source code must retain the above copyright
12% notice, this list of conditions and the following disclaimer.
13%
14% - Redistributions in binary form must reproduce the above copyright
15% notice, this list of conditions and the following disclaimer in the
16% documentation and/or other materials provided with the distribution.
17%
18% - Neither the name of John MacFarlane nor the names of other
19% contributors may be used to endorse or promote products derived
20% from this software without specific prior written permission.
21%
22% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23% "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24% LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25% FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26% COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27% INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28% BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29% LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30% CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31% LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32% ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33% POSSIBILITY OF SUCH DAMAGE.
34%%
35
36%%
37% For usage information and examples visit the GitHub page of this template:
38% https://github.com/Wandmalfarbe/pandoc-latex-template
39%%
40
41\PassOptionsToPackage{unicode=true}{hyperref} % options for packages loaded elsewhere
42\PassOptionsToPackage{hyphens}{url}
43$if(colorlinks)$
44\PassOptionsToPackage{dvipsnames,svgnames*,x11names*,table}{xcolor}
45$endif$
46%
47\documentclass[$if(fontsize)$$fontsize$,$endif$$if(lang)$$babel-lang$,$endif$$if(papersize)$$papersize$paper,$else$a4paper,$endif$$if(beamer)$ignorenonframetext,$if(handout)$handout,$endif$$if(aspectratio)$aspectratio=$aspectratio$,$endif$$endif$$for(classoption)$$classoption$$sep$,$endfor$]{scrartcl}
48$if(beamer)$
49\setbeamertemplate{caption}[numbered]
50\setbeamertemplate{caption label separator}{: }
51\setbeamercolor{caption name}{fg=normal text.fg}
52\beamertemplatenavigationsymbols$if(navigation)$$navigation$$else$empty$endif$
53$endif$
54$if(beamerarticle)$
55\usepackage{beamerarticle} % needs to be loaded first
56$endif$
57$if(fontfamily)$
58\usepackage[$for(fontfamilyoptions)$$fontfamilyoptions$$sep$,$endfor$]{$fontfamily$}
59$else$
60\usepackage{lmodern}
61$endif$
62$if(linestretch)$
63\usepackage{setspace}
64\setstretch{$linestretch$}
65$endif$
66\usepackage{amssymb,amsmath}
67\usepackage{ifxetex,ifluatex}
68\usepackage{fixltx2e} % provides \textsubscript
69\ifnum 0\ifxetex 1\fi\ifluatex 1\fi=0 % if pdftex
70 \usepackage[$if(fontenc)$$fontenc$$else$T1$endif$]{fontenc}
71 \usepackage[utf8]{inputenc}
72 \usepackage{textcomp} % provides euro and other symbols
73\else % if luatex or xelatex
74$if(mathspec)$
75 \ifxetex
76 \usepackage{mathspec}
77 \else
78 \usepackage{unicode-math}
79 \fi
80$else$
81 \usepackage{unicode-math}
82$endif$
83 \defaultfontfeatures{Ligatures=TeX,Scale=MatchLowercase}
84$for(fontfamilies)$
85 \newfontfamily{$fontfamilies.name$}[$fontfamilies.options$]{$fontfamilies.font$}
86$endfor$
87$if(mainfont)$
88 \setmainfont[$for(mainfontoptions)$$mainfontoptions$$sep$,$endfor$]{$mainfont$}
89$endif$
90$if(sansfont)$
91 \setsansfont[$for(sansfontoptions)$$sansfontoptions$$sep$,$endfor$]{$sansfont$}
92$endif$
93$if(monofont)$
94 \setmonofont[Mapping=tex-ansi$if(monofontoptions)$,$for(monofontoptions)$$monofontoptions$$sep$,$endfor$$endif$]{$monofont$}
95$endif$
96$if(mathfont)$
97$if(mathspec)$
98 \ifxetex
99 \setmathfont(Digits,Latin,Greek)[$for(mathfontoptions)$$mathfontoptions$$sep$,$endfor$]{$mathfont$}
100 \else
101 \setmathfont[$for(mathfontoptions)$$mathfontoptions$$sep$,$endfor$]{$mathfont$}
102 \fi
103$else$
104 \setmathfont[$for(mathfontoptions)$$mathfontoptions$$sep$,$endfor$]{$mathfont$}
105$endif$
106$endif$
107$if(CJKmainfont)$
108 \ifxetex
109 \usepackage{xeCJK}
110 \setCJKmainfont[$for(CJKoptions)$$CJKoptions$$sep$,$endfor$]{$CJKmainfont$}
111 \fi
112$endif$
113$if(luatexjapresetoptions)$
114 \ifluatex
115 \usepackage[$for(luatexjapresetoptions)$$luatexjapresetoptions$$sep$,$endfor$]{luatexja-preset}
116 \fi
117$endif$
118$if(CJKmainfont)$
119 \ifluatex
120 \usepackage[$for(luatexjafontspecoptions)$$luatexjafontspecoptions$$sep$,$endfor$]{luatexja-fontspec}
121 \setmainjfont[$for(CJKoptions)$$CJKoptions$$sep$,$endfor$]{$CJKmainfont$}
122 \fi
123$endif$
124\fi
125$if(beamer)$
126$if(theme)$
127\usetheme[$for(themeoptions)$$themeoptions$$sep$,$endfor$]{$theme$}
128$endif$
129$if(colortheme)$
130\usecolortheme{$colortheme$}
131$endif$
132$if(fonttheme)$
133\usefonttheme{$fonttheme$}
134$endif$
135$if(mainfont)$
136\usefonttheme{serif} % use mainfont rather than sansfont for slide text
137$endif$
138$if(innertheme)$
139\useinnertheme{$innertheme$}
140$endif$
141$if(outertheme)$
142\useoutertheme{$outertheme$}
143$endif$
144$endif$
145% use upquote if available, for straight quotes in verbatim environments
146\IfFileExists{upquote.sty}{\usepackage{upquote}}{}
147% use microtype if available
148\IfFileExists{microtype.sty}{%
149\usepackage[$for(microtypeoptions)$$microtypeoptions$$sep$,$endfor$]{microtype}
150\UseMicrotypeSet[protrusion]{basicmath} % disable protrusion for tt fonts
151}{}
152$if(indent)$
153$else$
154\IfFileExists{parskip.sty}{%
155\usepackage{parskip}
156}{% else
157\setlength{\parindent}{0pt}
158\setlength{\parskip}{6pt plus 2pt minus 1pt}
159}
160$endif$
161$if(verbatim-in-note)$
162\usepackage{fancyvrb}
163$endif$
164$if(colorlinks)$
165\usepackage{xcolor}
166\definecolor{default-citecolor}{HTML}{4077C0}
167\definecolor{default-urlcolor}{HTML}{4077C0}
168$endif$
169\usepackage{hyperref}
170\hypersetup{
171$if(title-meta)$
172 pdftitle={$title-meta$},
173$endif$
174$if(author-meta)$
175 pdfauthor={$author-meta$},
176$endif$
177$if(subject)$
178 pdfsubject={$subject$},
179$endif$
180$if(keywords)$
181 pdfkeywords={$for(keywords)$$keywords$$sep$, $endfor$},
182$endif$
183$if(tags)$
184 pdfkeywords={$for(tags)$$tags$$sep$, $endfor$},
185$endif$
186$if(colorlinks)$
187 colorlinks=true,
188 linkcolor=$if(linkcolor)$$linkcolor$$else$Maroon$endif$,
189 citecolor=$if(citecolor)$$citecolor$$else$default-citecolor$endif$,
190 urlcolor=$if(urlcolor)$$urlcolor$$else$default-urlcolor$endif$,
191$else$
192 pdfborder={0 0 0},
193$endif$
194 breaklinks=true}
195\urlstyle{same} % don't use monospace font for urls
196$if(verbatim-in-note)$
197\VerbatimFootnotes % allows verbatim text in footnotes
198$endif$
199$if(geometry)$
200\usepackage[margin=2.5cm,includehead=true,includefoot=true,centering,$for(geometry)$$geometry$$sep$,$endfor$]{geometry}
201$else$
202\usepackage[margin=2.5cm,includehead=true,includefoot=true,centering]{geometry}
203$endif$
204$if(beamer)$
205\newif\ifbibliography
206$endif$
207$if(natbib)$
208\usepackage[$natbiboptions$]{natbib}
209\bibliographystyle{$if(biblio-style)$$biblio-style$$else$plainnat$endif$}
210$endif$
211$if(biblatex)$