Engineering thesis

TODO

Project board

Usage

If you render this project for the first time, simply run make. Otherwise:

1. Install dependencies (only once)

   make install

2. Generate PDF

   make pdf

   • Watch mode (optional for development)

     make watch

3. Open PDF in a viewer

   make open

4. Release and push to Github

   make release

Tips

Use Semantic Line Breaks.

Figure template

\begin{figure}[h]
  \centering
  \includegraphics[width=10cm,keepaspectratio]{path}
  \caption{Caption}
  \label{fig:label}
\end{figure}

Based on ArturB/WUT-Thesis, with additional cleanup and refactoring.

---

Troubleshooting

Install biber:

Arch Linux:

sudo pacman -S biber

Ubuntu:

sudo apt install biber

MacOS:

brew install biber

When latexindent fails, some perl modules may be missing. In my case, on Arch Linux, it was:

sudo pacman -S \
  perl-eval-closure \
  perl-file-homedir \
  perl-log-log4perl \
  perl-namespace-autoclean \
  perl-params-validationcompiler \
  perl-specio \
  perl-unicode-linebreak \
  perl-yaml-tiny

On Ubuntu, simply run:

sudo apt install \
  texlive-full \
  texlive-extra-utils \
  latexmk

Note that it takes quite a bit of time.

On MacOS:

brew install latexindent

To properly set up the line wrapping in the listings package, all of the above options have to be set up:

\lstdefinestyle{codestyle}{
    breakatwhitespace=false,
    breaklines=true,
    prebreak=\space,
    postbreak=\space
}
\lstset{style=codestyle}

The current listings setup is as follows:

% Code listings
\RequirePackage[dvipsnames]{xcolor} % 68 additional named colors (CMYK)
\RequirePackage{listings}
\lstdefinestyle{codestyle}{
    commentstyle=\color{darkgray},
    keywordstyle=\color{Mulberry},
    stringstyle=\color{RoyalBlue},
    numberstyle=\tiny\color{Gray},
    basicstyle=\footnotesize\bfseries\ttfamily,
    breakatwhitespace=false,
    breaklines=true,
    prebreak=\space\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookleftarrow}},
    postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow}}\space,
    captionpos=b,
    keepspaces=true,
    numbers=left,
    numbersep=5pt,
    showspaces=false,
    showstringspaces=false,
    showtabs=false,
    tabsize=4,
}
\lstset{style=codestyle}
% listings custom syntax
%% diff
\lstdefinelanguage{diff}{
    morecomment=[f][\color{RoyalBlue}]{@@}, % group identifier
    morecomment=[f][\color{BrickRed}]-,     % deleted lines
    morecomment=[f][\color{OliveGreen}]+,   % added lines
    morecomment=[f][\color{Mulberry}]{---}, % diff header lines (must appear after +,-)
    morecomment=[f][\color{Mulberry}]{+++},
}