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

Update README.md with updated usage instructions

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

17
README.md
View File

@ -39,15 +39,22 @@ Libs should be categorized under `libs/` based on functionality, and then contai
Add this repository as a submodule:
```bash
git submodule add https://github.com/open-x4-epaper/community-sdk.git lib/openx4
git submodule add https://github.com/open-x4-epaper/community-sdk.git open-x4-sdk
```
Then include any library you want in your code:
Then include add the lib categories you need into your `platformio.ini` file:
```ini
lib_extra_dirs =
open-x4-sdk/libs/display
open-x4-sdk/libs/hardware
```
Then you can include the libraries in your project as needed:
```cpp
#include <openx4/display/BufferedEinkDisplay/BufferedEinkDisplay.h>
#include <openx4/graphics/Canvas/Canvas.h>
```
#include <BatteryMonitor.h>
#include <EpdScreenController.h>
`````
Or load tools from the `tools/` directory as needed.