Skip to content

Commit df3f64a

Browse files
committed
Local build instructions
1 parent c8ee90f commit df3f64a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,18 @@ This repository includes a test suite that covers most of the API and that is de
4444

4545
Please help us improve the coverage of the test suite!
4646

47+
#### To build and run unit tests
48+
49+
The unit tests are automatically built by GitHub as part of pull request checks (in `.github/workflows/unit-tests.yml`).
50+
51+
To build and run locally (from the project root):
52+
53+
```
54+
cmake -S test -B test/build
55+
make --directory test/build
56+
test/build/bin/test-ArduinoCore-API
57+
```
58+
4759
### Implementing ArduinoCore-API
4860

4961
In order to compile a core which is implementing ArduinoCore-API you'll need to copy/symlink the `api` directory to the target's `cores/arduino` directory as part of your development and release workflow. The most elegant and effective solution is to develop your core with `api` symlinked and produce the distributable archive by telling `tar` to follow symlinks. Example:

0 commit comments

Comments
 (0)