diff options
author | Florian Pritz <bluewind@xinu.at> | 2018-07-28 15:10:15 +0200 |
---|---|---|
committer | Florian Pritz <bluewind@xinu.at> | 2018-07-28 15:10:15 +0200 |
commit | 463aeb281230f8768c660b9fb0d18069d157d8ef (patch) | |
tree | 6c09e10b0155860ca24a8d2e187c9861c4ac7ee1 /lib | |
parent | b7b5b6e0c1309d9c8bf0510c878a63aa0b80c885 (diff) | |
download | templogger-v2-463aeb281230f8768c660b9fb0d18069d157d8ef.tar.gz templogger-v2-463aeb281230f8768c660b9fb0d18069d157d8ef.tar.xz |
Port to platformio
Signed-off-by: Florian Pritz <bluewind@xinu.at>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/readme.txt | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/lib/readme.txt b/lib/readme.txt new file mode 100644 index 0000000..131f1bf --- /dev/null +++ b/lib/readme.txt @@ -0,0 +1,41 @@ + +This directory is intended for the project specific (private) libraries. +PlatformIO will compile them to static libraries and link to executable file. + +The source code of each library should be placed in separate directory, like +"lib/private_lib/[here are source files]". + +For example, see how can be organized `Foo` and `Bar` libraries: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) http://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- readme.txt --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +Then in `src/main.c` you should use: + +#include <Foo.h> +#include <Bar.h> + +// rest H/C/CPP code + +PlatformIO will find your libraries automatically, configure preprocessor's +include paths and build them. + +More information about PlatformIO Library Dependency Finder +- http://docs.platformio.org/page/librarymanager/ldf.html |