lib/readme.txt

Sun, 01 Nov 2020 22:11:39 +0100

author
David Douard <david.douard@sdf3.org>
date
Sun, 01 Nov 2020 22:11:39 +0100
changeset 41
5bed3318e563
parent 0
f3377957d8c0
permissions
-rw-r--r--

rename fp environment as fp_dfu and add a fp_stlink

to make it a bit easier to choose the selected upload protocol


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
|  |--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.

See additional options for PlatformIO Library Dependency Finder `lib_*`:

http://docs.platformio.org/en/latest/projectconf.html#lib-install

mercurial