diff options
| author | Torben Egmose <torben.egmose@gmail.com> | 2021-02-07 21:50:25 +0100 |
|---|---|---|
| committer | Torben Egmose <torben.egmose@gmail.com> | 2021-02-07 21:50:25 +0100 |
| commit | 8047228ff0bf9a738000c6ca2b354f7acf46985a (patch) | |
| tree | 47e0b5e122ec084a7f309ae37b7c99174b8958d0 /lib | |
init commit
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/README | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..8c9c29c --- /dev/null +++ b/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
|