diff options
| author | Max-001 <80035972+Max-001@users.noreply.github.com> | 2024-09-12 16:10:09 +0200 |
|---|---|---|
| committer | Max-001 <80035972+Max-001@users.noreply.github.com> | 2024-09-12 16:10:09 +0200 |
| commit | eab8e502f173d3efb22f48da1c64cb4428905103 (patch) | |
| tree | 7dffdcaa3e1fd73f7a5503f0e3835bbb87af260f /readme.md | |
| parent | 57b1d29670d4b8dbe1b3b00cad6f74a172a4d30b (diff) | |
| parent | 6ff3195cfee6eeeedd730a3b18473eb2f88efc23 (diff) | |
Merge remote-tracking branch 'origin/jaro/project-plan' into max/project-plan
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -10,9 +10,22 @@ Please see [style.md](./style.md) for writing style and - 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]. +- A [makefile](./makefile) is used to compile other files (e.g. plantuml + diagrams, [time report](#time-report)) - 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) + +## Time report + +The time report document includes generated LaTeX code which can be compiled +from [time.txt](./time.txt) using [time2tex.py](./time2tex.py). The +[makefile](./makefile) includes a rule that does this, so `make timerep.pdf` +should be used to compile this document specifically. + +## Requirements + +TODO: how to store + cross-reference requirements w/o extra latex compilation +runs [vscode]: https://code.visualstudio.com [latexworkshop]: https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop |