summaryrefslogtreecommitdiff
path: root/robot/readme.md
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2022-05-14 12:04:14 +0200
committerlonkaars <loek@pipeframe.xyz>2022-05-14 12:04:14 +0200
commitbf47775133d9e9c90e791e5e3b7e78460ddfcee9 (patch)
tree30e0cd69ed35d667ffa6f385bcac9bb8af39641a /robot/readme.md
parent11b6d9fb523d6c248e8593c7ac2ad1e6ca4e4b15 (diff)
add orangutan header notice to robot readme
Diffstat (limited to 'robot/readme.md')
-rw-r--r--robot/readme.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/robot/readme.md b/robot/readme.md
index 6be2f81..4a7aca3 100644
--- a/robot/readme.md
+++ b/robot/readme.md
@@ -93,6 +93,8 @@ this list will probably get updated from time to time:
- arbitrary numbers should be aliased to `#define` statements or `enum`s if
part of a series.
- general constants should be placed in `consts.h`
+- don't import `<pololu/orangutan.h>` directly, instead use
+ `"orangutan_shim.h"` to keep code compatible with the simulator
## todo