diff options
Diffstat (limited to 'lib/README')
| -rw-r--r-- | lib/README | 16 |
1 files changed, 8 insertions, 8 deletions
@@ -1,11 +1,11 @@ This directory is intended for project specific (private) libraries. -PlatformIO will compile them to static libraries and link into executable file. +PlatformIO will compile them to static libraries and link into the executable file. -The source code of each library should be placed in an own separate directory -("lib/your_library_name/[here are source files]"). +The source code of each library should be placed in a separate directory +("lib/your_library_name/[Code]"). -For example, see a structure of the following two libraries `Foo` and `Bar`: +For example, see the structure of the following example libraries `Foo` and `Bar`: |--lib | | @@ -15,7 +15,7 @@ For example, see a structure of the following two libraries `Foo` and `Bar`: | | |--src | | |- Bar.c | | |- Bar.h -| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | |- library.json (optional. for custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html | | | |--Foo | | |- Foo.c @@ -27,7 +27,7 @@ For example, see a structure of the following two libraries `Foo` and `Bar`: |--src |- main.c -and a contents of `src/main.c`: +Example contents of `src/main.c` using Foo and Bar: ``` #include <Foo.h> #include <Bar.h> @@ -39,8 +39,8 @@ int main (void) ``` -PlatformIO Library Dependency Finder will find automatically dependent -libraries scanning project source files. +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 |