Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit e26862e

Browse filesBrowse files
authored
Merge pull request #170 from sgryphon/feature/build-instructions
Add some basic build instructions to run unit tests
2 parents c8ee90f + f2624d1 commit e26862e
Copy full SHA for e26862e

File tree

Expand file treeCollapse file tree

1 file changed

+26
-1
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+26
-1
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+26-1Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,36 @@ 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:
52+
53+
**Dependencies**
54+
55+
* [CMake](https://cmake.org/)
56+
* [GCC](https://gcc.gnu.org/)
57+
58+
On (Ubuntu) Linux run:
59+
60+
```bash
61+
sudo apt-get install build-essential cmake
62+
```
63+
64+
From the project root:
65+
66+
```bash
67+
cd test && mkdir build && cd build
68+
cmake ..
69+
make && bin/test-ArduinoCore-API
70+
```
71+
4772
### Implementing ArduinoCore-API
4873

4974
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:
5075

51-
```
76+
```bash
5277
tar --exclude='*.git*' -cjhvf $yourcore-$version.tar.bz2 $yourcore/
5378
```
5479

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.