aboutsummaryrefslogtreecommitdiff
path: root/readme.md
blob: e8b37849c8cf67ce1dcdd01bb0bba4e50229a4be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# crêpe docs

systems programming in c++ minor project documentation

Please see [style.md](./style.md) for writing style and
[contributing.md](./contributing.md) for coding and git standards.

## Compilation

- A `latexmkrc` file is provided for copmilation with `latexmk`. The documents
  should also compile under [Visual Studio Code][vscode] using the [LaTeX
  Workshop extension][latexworkshop], as well as [VimTeX][vimtex].
- These documents use fonts loaded using `fontspec`, please see
  [style.md](./style.md) for download links.
- A `makefile` is provided for compiling other files (e.g. plantuml diagrams)

[vscode]: https://code.visualstudio.com
[latexworkshop]: https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop
[vimtex]: https://github.com/lervag/vimtex