Skip to content

Commit a7d848a

Browse files
committed
README: Add instructions for install.sh
Signed-off-by: Dhruva Gole <[email protected]>
1 parent 79988d7 commit a7d848a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ Arduino Core API module for zephyr leverages the power of Zephyr under an Arduin
2828
west update
2929
```
3030

31+
* **Note:** For ***Linux users only*** there exists an ``install.sh`` script in this project that can be run to quickly link the ArduinoCore-API to this module.
32+
If you are able to run that script successfully then you can skip the next steps.
33+
3134
* To "complete" the core you need to copy or symlink the api folder from the [ArduinoCore-API](https://github.com/arduino/ArduinoCore-API.git) repo to the target's ``cores/arduino`` folder:
3235
```sh
3336
$ git clone [email protected]:arduino/ArduinoCore-API # Any location
@@ -36,6 +39,9 @@ $ ln -s /<your>/<location>/ArduinoCore-API/api cores/arduino/.
3639
The `cores` folder can be found at `~/zephyrproject/modules/lib/Arduino-Zephyr-API/cores`.
3740

3841
**Known Bug(s):**
42+
43+
__NOTE:__ You can skip this step as well if you ran ``install.sh``.
44+
3945
* While compiling with the ArduinoCore-API `WCharacter.h` produces many errors. The include of that file needs to be deleted from `cores/arduino/api/ArduinoAPI.h` (it is unused in this port.) We are looking into resolving the issue.
4046

4147
**Maintainers**:

0 commit comments

Comments
 (0)