aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-09-10 12:10:21 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-09-10 12:10:21 +0200
commite34bef0a738c710e8c09894f6d9bc66abda4d3b2 (patch)
treee5cd87226d5f27e5b454b97c635c05b75fc8c170
parentec881fd9ce58f09e0be598e11c5f5820d8431eda (diff)
update readme + time.txt
-rw-r--r--readme.md15
-rw-r--r--time.txt3
2 files changed, 17 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index e8b3784..1375c5e 100644
--- a/readme.md
+++ b/readme.md
@@ -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
diff --git a/time.txt b/time.txt
index 086197a..db345f3 100644
--- a/time.txt
+++ b/time.txt
@@ -14,6 +14,9 @@ loek: 2024-09-06 55m time report script
loek: 2024-09-09 30m feedback :: niels code style guide
loek: 2024-09-09 45m review :: wouter research PR#5
loek: 2024-09-09 25m documentation style guide
+loek: 2024-09-10 1h55m project meeting
+loek: 2024-09-10 25m briefing :: watch bob videos
+loek: 2024-09-10 5m docs :: update readme
max: 2024-09-02 1h project meeting :: project kickoff
max: 2024-09-02 45m project meeting