summaryrefslogtreecommitdiff
path: root/code/debug/camera/communication/rx_teensy/lib
diff options
context:
space:
mode:
authorAbel Tim <git@abeltim.com>2025-05-12 20:56:11 +0200
committerAbel Tim <git@abeltim.com>2025-05-12 20:56:11 +0200
commitc007afbd2c1339d58a582a905f07a5b39ddaafbd (patch)
tree367431b4c5095442cc7b714f4849ef35d206bff2 /code/debug/camera/communication/rx_teensy/lib
parent1fb85fcf2582320cc41621b90adbb0a1aef551e0 (diff)
downloadrobotica-c007afbd2c1339d58a582a905f07a5b39ddaafbd.tar.gz
robotica-c007afbd2c1339d58a582a905f07a5b39ddaafbd.zip
cam comm + readme -4
Multi-line description of commit, feel free to be detailed. Signed-off-by: Abel Tim <git@abeltim.com>
Diffstat (limited to 'code/debug/camera/communication/rx_teensy/lib')
-rw-r--r--code/debug/camera/communication/rx_teensy/lib/README46
1 files changed, 46 insertions, 0 deletions
diff --git a/code/debug/camera/communication/rx_teensy/lib/README b/code/debug/camera/communication/rx_teensy/lib/README
new file mode 100644
index 0000000..9379397
--- /dev/null
+++ b/code/debug/camera/communication/rx_teensy/lib/README
@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into the executable file.
+
+The source code of each library should be placed in a separate directory
+("lib/your_library_name/[Code]").
+
+For example, see the structure of the following example libraries `Foo` and `Bar`:
+
+|--lib
+| |
+| |--Bar
+| | |--docs
+| | |--examples
+| | |--src
+| | |- Bar.c
+| | |- Bar.h
+| | |- library.json (optional. for custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+| |
+| |--Foo
+| | |- Foo.c
+| | |- Foo.h
+| |
+| |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+ |- main.c
+
+Example contents of `src/main.c` using Foo and Bar:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+ ...
+}
+
+```
+
+The PlatformIO Library Dependency Finder will find automatically dependent
+libraries by scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html