summaryrefslogtreecommitdiff
path: root/shared/readme.md
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2022-05-24 21:56:59 +0200
committerlonkaars <loek@pipeframe.xyz>2022-05-24 21:56:59 +0200
commit937a3a736aaf2c468c8c8e8dbc7963a87eae890f (patch)
treedb8d9a717727b907c77c24aff98ed90c82ccb22a /shared/readme.md
parentede8a89706209fa26e151a34a28e64affbffd23d (diff)
move some code to a shared folder
Diffstat (limited to 'shared/readme.md')
-rw-r--r--shared/readme.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/shared/readme.md b/shared/readme.md
new file mode 100644
index 0000000..870f015
--- /dev/null
+++ b/shared/readme.md
@@ -0,0 +1,8 @@
+# shared code
+
+this is the subdirectory for all code that is shared between the robot code and
+the client code. to use these, include the .h files with a relative path (e.g.
+`#include "../shared/consts.h"`). makefiles should add `include
+../shared/makefile` to add the .c and .h files to `$SOURCES` and `$HEADERS` in
+the makefile targets (this is already done for the robot and client
+subdirectories).