readme.txt 873 B

123456789101112131415161718192021222324252627282930313233343536
  1. This directory is intended for the project specific (private) libraries.
  2. PlatformIO will compile them to static libraries and link to executable file.
  3. The source code of each library should be placed in separate directory, like
  4. "lib/private_lib/[here are source files]".
  5. For example, see how can be organized `Foo` and `Bar` libraries:
  6. |--lib
  7. | |--Bar
  8. | | |--docs
  9. | | |--examples
  10. | | |--src
  11. | | |- Bar.c
  12. | | |- Bar.h
  13. | |--Foo
  14. | | |- Foo.c
  15. | | |- Foo.h
  16. | |- readme.txt --> THIS FILE
  17. |- platformio.ini
  18. |--src
  19. |- main.c
  20. Then in `src/main.c` you should use:
  21. #include <Foo.h>
  22. #include <Bar.h>
  23. // rest H/C/CPP code
  24. PlatformIO will find your libraries automatically, configure preprocessor's
  25. include paths and build them.
  26. More information about PlatformIO Library Dependency Finder
  27. - http://docs.platformio.org/en/stable/librarymanager/ldf.html