blob: 7b58cfd93eac95691551b03a4c5d2e8d19f678db (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
# 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
Requirements:
- A LaTeX distribution that includes the XeLaTeX compiler and latexmk
- PlantUML
- Python 3
- Fonts (see see [style.md](./style.md) for download links)
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].
## TODO
- Requirement cross-references are broken (they print both the label and the
path to the other document, should be label only). Interesting:
`\creflabelformat` and `\@templabel` (inside #2 of `\creflabelformat`).
[vscode]: https://code.visualstudio.com
[latexworkshop]: https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop
[vimtex]: https://github.com/lervag/vimtex
|