diff options
author | Matthias P. Braendli <matthias.braendli@mpb.li> | 2023-05-18 13:42:52 +0200 |
---|---|---|
committer | Matthias P. Braendli <matthias.braendli@mpb.li> | 2023-05-18 13:42:52 +0200 |
commit | 844aeaf0a685180633107e89b9d28023ae05bd78 (patch) | |
tree | 2cb00f749e37507b88ae40d7f11f6690764cb3b3 /tracker-stm32/lib/README | |
parent | a574c239214a963bec1a2229c077af261130277c (diff) | |
download | lora-aprs-hb9egm-a.tar.gz lora-aprs-hb9egm-a.tar.bz2 lora-aprs-hb9egm-a.zip |
Move tracker into subdira
Diffstat (limited to 'tracker-stm32/lib/README')
-rw-r--r-- | tracker-stm32/lib/README | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/tracker-stm32/lib/README b/tracker-stm32/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/tracker-stm32/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 executable file. + +The source code of each library should be placed in a an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, 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 + +and a contents of `src/main.c`: +``` +#include <Foo.h> +#include <Bar.h> + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html |