aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-09-17 15:13:31 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-09-17 15:13:31 +0200
commit5c0649ac31b030cbb3c8c5e0684ee9419fe50054 (patch)
tree8cc5f25c1de11d50ec8fab196626145ef0cefaae /readme.md
parent69bb15bd19cd62b39e2af8a2ab890b1ce25f514c (diff)
parent5aba97da07413c498871c5da4ce8d0f2427ffc69 (diff)
Merge branch 'loek/requirements'
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/readme.md b/readme.md
index b63392b..7b58cfd 100644
--- a/readme.md
+++ b/readme.md
@@ -9,19 +9,20 @@ Please see [style.md](./style.md) for writing style and
Requirements:
-- A LaTeX distribution that includes the XeLaTeX compiler
+- A LaTeX distribution that includes the XeLaTeX compiler and latexmk
- PlantUML
-- Python 3 (timerep only)
+- Python 3
- Fonts (see see [style.md](./style.md) for download links)
-A `latexmkrc` file is provided for copmilation with `latexmk`. The documents
+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
+## TODO
-TODO: how to store + cross-reference requirements w/o extra latex compilation
-runs
+- 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