crêpe docs

systems programming in c++ minor project documentation

Please see style.md for writing style and contributing.md for coding and git standards. There is also an example document which may be used to copy/paste LaTeX snippets for specific formatting.

Compilation

Prerequisites:

• A LaTeX distribution that includes XeLaTeX and latexmk
• PlantUML
• Python 3
• Fonts (see see style.md for download links)

All documents are compiled using latexmk, and this repository contains additional configuration files for the following editors:

• Visual Studio Code + LaTeX Workshop
• (Neo)Vim + VimTeX (source .vimrc to fix custom verb command highlighting)

Special files

• time.txt contains tracked time for each team member. This file is automatically converted using time2tex when compiling timerep.tex.
• reqs.toml contains the project requirements. This file is converted using reqs2tex for requirements.tex and also generates an .aux file for cross-referencing the requirements from other documents.
• sources.bib contains all bibliography entries / references
• glossary.bib contains all glossary entries