aboutsummaryrefslogtreecommitdiff
path: root/docs/readme.md
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2024-04-20 15:53:24 +0200
committerlonkaars <loek@pipeframe.xyz>2024-04-20 15:53:24 +0200
commitebcc6e19d2fdddbbce6d3ac93ec9ac29663a1d7e (patch)
tree7bfe16ac771a466bbcb4ad26d4de18a8c78897df /docs/readme.md
parent4394f1a0122c81439e648d17c1c0f5855229f74b (diff)
give referenced requirements meaningful identifiers + comment TODOs in text
Diffstat (limited to 'docs/readme.md')
-rw-r--r--docs/readme.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/readme.md b/docs/readme.md
index e58c5fb..c5067b5 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -9,6 +9,8 @@ makefile is provided for convenience.
- "I<sup>2</sup>C" is written as `I^2^C`
- "C++" is written as `{cpp}`
+- please give cross references, links, image files, figure ids, etc. meaningful
+ names
## TODO