Skip to content

Commit fe54804

Browse files
committed
README: Add instructions
Signed-off-by: Dhruva Gole <[email protected]>
1 parent 8565f3e commit fe54804

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,35 @@
66

77
Arduino Core API module for zephyr leverages the power of Zephyr under an Arduino-C++ style abtraction layer thus helping zephyr new-comers to start using it without worrying about learning about new APIs and libraries. Visit this project's [official blog](https://dhruvag2000.github.io/Blog-GSoC22/) for documentation.
88

9+
## Adding Arduino Core API to Zephyr
10+
11+
Add following entry to `west.yml` file in `manifest/projects` subtree of Zephyr:
12+
```
13+
# Arduino API repository.
14+
- name: Arduino-Core-Zephyr
15+
path: modules/lib/Arduino-Zephyr-API
16+
revision: dev
17+
url: https://github.com/zephyrproject-rtos/gsoc-2022-arduino-core
18+
```
19+
20+
and clone the repository by running
21+
22+
```sh
23+
west update
24+
```
25+
926
To "complete" the core you need to copy or symlink the api folder from [this repo](https://github.com/arduino/ArduinoCore-API.git) to the target's ``cores/arduino`` folder:
1027
```sh
1128
$ git clone [email protected]:arduino/ArduinoCore-API # Any location
1229
$ ln -s /<your>/<location>/ArduinoCore-API/api cores/arduino/.
1330
```
1431

15-
Maintainers:
32+
**Maintainers**:
1633
- beriberikix
1734
- szczys
1835
- alvarowolfx
1936

20-
Contributor(s):
21-
[DhruvaG2000](https://github.com/DhruvaG2000)
37+
**Contributor**: [DhruvaG2000](https://github.com/DhruvaG2000)
2238

2339
## License
2440
Please note that the current license is Apache 2. Previously it was LGPL 2.1 but after careful review it was determined that no LGPL code or derivates was used and the more permissive license was chosen.

0 commit comments

Comments
 (0)