Skip to content

Commit 8565f3e

Browse files
committed
update README
Signed-off-by: Dhruva Gole <[email protected]>
1 parent 71517fc commit 8565f3e

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,21 @@
44

55
## Arduino Core API module for zephyr
66

7-
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.
7+
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.
8+
9+
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:
10+
```sh
11+
$ git clone [email protected]:arduino/ArduinoCore-API # Any location
12+
$ ln -s /<your>/<location>/ArduinoCore-API/api cores/arduino/.
13+
```
814

915
Maintainers:
10-
- jonathanberi
16+
- beriberikix
1117
- szczys
1218
- alvarowolfx
1319

1420
Contributor(s):
15-
DhruvaG2000
21+
[DhruvaG2000](https://github.com/DhruvaG2000)
1622

1723
## License
18-
Please note that the current license is [LGPL 2.1](https://github.com/zephyrproject-rtos/gsoc-2022-arduino-core/blob/dev/LICENSE) before using it in your applications. Due to [licensing requirements](https://docs.zephyrproject.org/latest/contribute/external.html#) of the Zephyr project, this module cannot be included in the official distribution of Zephyr at this time and the maintainers of this repository have no plans to do so.
24+
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)