Skip to content
This repository was archived by the owner on Aug 12, 2022. It is now read-only.

Commit 529f77d

Browse files
DhruvaG2000beriberikix
authored andcommitted
README: update instructions and known bugs
Signed-off-by: Dhruva Gole <goledhruva@gmail.com>
1 parent 3679a9d commit 529f77d

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Arduino Core API module for zephyr leverages the power of Zephyr under an Arduin
88

99
## Adding Arduino Core API to Zephyr
1010

11-
Add following entry to `west.yml` file in `manifest/projects` subtree of Zephyr:
11+
* **Pre requisites:** It is assumed that you have zephyrproject configured and installed on your system as per the official [Get Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html). The recommended path to install is `~/zephyrproject` as specified in the guide. You may face path issues if you have zephyr installed in a custom path.
12+
13+
* Add following entry to `west.yml` file in `manifest/projects` subtree of Zephyr:
1214
```
1315
# Arduino API repository.
1416
- name: Arduino-Core-Zephyr
@@ -17,21 +19,20 @@ Add following entry to `west.yml` file in `manifest/projects` subtree of Zephyr:
1719
url: https://github.com/zephyrproject-rtos/gsoc-2022-arduino-core
1820
```
1921

20-
and clone the repository by running
22+
* Then, clone the repository by running
2123

2224
```sh
2325
west update
2426
```
2527

26-
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:
28+
* 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:
2729
```sh
2830
$ git clone git@github.com:arduino/ArduinoCore-API # Any location
2931
$ ln -s /<your>/<location>/ArduinoCore-API/api cores/arduino/.
3032
```
3133

32-
**Known Bugs:**
33-
While compiling with the ArduinoCore-API `WCharacter.h` produces many errors. It needs to be deleted from ArduinoAPI.h (it is unused in this port.) We are looking into resolving the issue.
34-
34+
**Known Bug(s):**
35+
* While compiling with the ArduinoCore-API `WCharacter.h` produces many errors. It needs to be deleted from ArduinoAPI.h (it is unused in this port.) We are looking into resolving the issue.
3536

3637
**Maintainers**:
3738
- [beriberikix](https://github.com/beriberikix)

0 commit comments

Comments
 (0)