Mercurial > hp34970-firmware / annotate
lib/readme.txt@d0826e4a1ff7 (annotated)
lib/readme.txt
Thu, 08 Sep 2016 20:02:23 +0200
- author
- David Douard <david.douard@logilab.fr>
- date
- Thu, 08 Sep 2016 20:02:23 +0200
- changeset 2
- d0826e4a1ff7
- parent 0
- f3377957d8c0
- permissions
- -rw-r--r--
several improvements
| 0 | 1 | |
| 2 | This directory is intended for the project specific (private) libraries. | |
| 3 | PlatformIO will compile them to static libraries and link to executable file. | |
| 4 | ||
| 5 | The source code of each library should be placed in separate directory, like | |
| 6 | "lib/private_lib/[here are source files]". | |
| 7 | ||
| 8 | For example, see how can be organized `Foo` and `Bar` libraries: | |
| 9 | ||
| 10 | |--lib | |
| 11 | | |--Bar | |
| 12 | | | |--docs | |
| 13 | | | |--examples | |
| 14 | | | |--src | |
| 15 | | | |- Bar.c | |
| 16 | | | |- Bar.h | |
| 17 | | |--Foo | |
| 18 | | | |- Foo.c | |
| 19 | | | |- Foo.h | |
| 20 | | |- readme.txt --> THIS FILE | |
| 21 | |- platformio.ini | |
| 22 | |--src | |
| 23 | |- main.c | |
| 24 | ||
| 25 | Then in `src/main.c` you should use: | |
| 26 | ||
| 27 | #include <Foo.h> | |
| 28 | #include <Bar.h> | |
| 29 | ||
| 30 | // rest H/C/CPP code | |
| 31 | ||
| 32 | PlatformIO will find your libraries automatically, configure preprocessor's | |
| 33 | include paths and build them. | |
| 34 | ||
| 35 | See additional options for PlatformIO Library Dependency Finder `lib_*`: | |
| 36 | ||
| 37 | http://docs.platformio.org/en/latest/projectconf.html#lib-install | |
| 38 |
