cottongin/community-sdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README with non-deprecated library include method

Browse Source
This commit is contained in:
Dave Allie 2025-12-03 08:16:39 +11:00
parent 182ff5f4ea
commit be0cb2bb34
No known key found for this signature in database
GPG Key ID: F2FDDB3AD8D0276F
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -42,15 +42,16 @@ Add this repository as a submodule:
git submodule add https://github.com/open-x4-epaper/community-sdk.git open-x4-sdk
```
Then include add the lib categories you need into your `platformio.ini` file:
Then add each lib you need into your `platformio.ini` file as `lib_deps`:
```ini
lib_extra_dirs =
open-x4-sdk/libs/display
open-x4-sdk/libs/hardware
lib_deps =
BatteryMonitor=symlink://open-x4-sdk/libs/hardware/BatteryMonitor
EpdScreenController=symlink://open-x4-sdk/libs/display/EpdScreenController
```
Then you can include the libraries in your project as needed:
Then you can include the libraries in your project as usual:
```cpp
#include <BatteryMonitor.h>
#include <EpdScreenController.h>