diff options
author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-09-14 11:14:55 +0200 |
---|---|---|
committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-09-14 11:14:55 +0200 |
commit | 26feeb970b5ac98747d5a0321d23be01bbf024f8 (patch) | |
tree | 2bd13d907ae20f481b45d7425f285ae0d2cf9ed9 /readme.md | |
parent | 4d085ec22a6d8560913f61096a83ebda4bbaa740 (diff) |
update readme + time.txt
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 24 |
1 files changed, 10 insertions, 14 deletions
@@ -7,20 +7,16 @@ Please see [style.md](./style.md) for writing style and ## 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]. -- 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. - -## 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: + +- A LaTeX distribution that includes the XeLaTeX compiler +- PlantUML +- Python 3 (timerep only) +- 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]. ## Requirements |