Debian Codegraph @

tools/spgen/documentation/documentation.tex

raw
1 \documentclass[a4paper,11pt]{article}
2 \usepackage[english]{babel}
3 \usepackage[utf8]{inputenc}
4 \usepackage{textcomp}
5 \usepackage[T1]{fontenc}
6
7 % slightly reduce ridiculous margins
8 \addtolength{\oddsidemargin}{-0.7in}
9 \addtolength{\evensidemargin}{-0.7in}
10 \addtolength{\textwidth}{1.4in}
11 \setlength{\headheight}{14pt}
12
13 %for images
14 %\usepackage[pdftex]{graphicx}
15
16 % remove indentation before paragraphs
17 \setlength\parindent{0pt}
18
19 % header
20 \usepackage{fancyhdr}
21 \pagestyle{fancy}
22 \fancyhead[L]{\texttt{spgen} documentation}
23 \fancyhead[R]{INRIA/LIP6 \today}
24
25 % urls
26 \usepackage{hyperref}
27 \hypersetup{pdfborder = {0 0 0}} %remove link borders
28
29 \title{\textbf{Documentation for \texttt{spgen}}}
30 \date{\today}
31 \author{Chi Pham}
32
33 \begin{document}
34 \maketitle
35 \tableofcontents
36 \newpage
37
38 \section{About}
39 We first provide information about the tool, its motivation, and its uses.
40 \input{about.tex}
41 \clearpage
42
43 \section{Usage}
44 This section contains information about how the tool is installed and used.
45 \input{usage.tex}
46 \clearpage
47
48 \section{Implementation}
49 This section contains information about the implementation details of the tool.
50 \input{implementation.tex}
51 \clearpage
52
53 \section{Known issues}
54 This section lists the known issues that might either cause the tool to fail or to generate an erroneous script.
55 \input{knownissues.tex}
56 \clearpage
57
58 \section{Future work}
59 This section lists the work to be done on the tool aside from fixing the known issues.
60 \input{future.tex}
61
62 \end{document}