aboutsummaryrefslogtreecommitdiff
path: root/docs/readme.md
diff options
context:
space:
mode:
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