esp-gamepad/receiver/lib/README

47 lines
1 KiB
Text
Raw Normal View History

2024-10-27 17:14:40 +01:00
This directory is intended for project specific (private) libraries.
PlatformIO will compile them to static libraries and link into executable file.
2024-10-27 18:18:42 +01:00
The source code of each library should be placed in a an own separate directory
2024-10-27 17:14:40 +01:00
("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