aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 11b11e5..e8b3784 100644
--- a/readme.md
+++ b/readme.md
@@ -5,3 +5,16 @@ 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
+