Skip to content

Commit 8983308

Browse files
aentingerper1234
andauthored
Document how to add the required link to ArduinoCore-API. (#676)
* Document how to add the required link to ArduinoCore-API. Related to arduino/ArduinoCore-API#96. * Update README.md Co-authored-by: per1234 <[email protected]> * Update README.md Co-authored-by: per1234 <[email protected]> * Update README.md Co-authored-by: per1234 <[email protected]> * Update README.md Co-authored-by: per1234 <[email protected]> Co-authored-by: per1234 <[email protected]>
1 parent b52412e commit 8983308

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,33 @@ to avoid duplicates.
3030
Contributions are always welcome. The preferred way to receive code contribution is by submitting a
3131
Pull Request on github.
3232

33+
## Developing
34+
35+
1. Clone the [ArduinoCore-API](https://github.com/arduino/ArduinoCore-API) repo to any convenient location:
36+
```
37+
git clone https://github.com/arduino/ArduinoCore-API.git
38+
```
39+
1. Create an `<SKETCHBOOK>/hardware/arduino-git` folder, where `<SKETCHBOOK>` is the location of your
40+
Arduino sketchbook.
41+
1. Change directories:
42+
```
43+
cd <SKETCHBOOK>/hardware/arduino-git
44+
```
45+
1. Clone this repo:
46+
```
47+
git clone https://github.com/arduino/ArduinoCore-samd.git samd
48+
```
49+
1. Change directories:
50+
```
51+
cd samd/cores/arduino
52+
```
53+
1. Copy or symlink the `api` folder from the [ArduinoCore-API](https://github.com/arduino/ArduinoCore-API) repo:
54+
```
55+
ln -s <ARDUINO_CORE_API>/api .
56+
```
57+
where `<ARDUINO_CORE_API>` is the location where you've cloned the ArduinoCore-API repository to.
58+
1. Restart the IDE.
59+
3360
## Hourly builds
3461

3562
This repository is under a Continuous Integration system that every hour checks if there are updates and

0 commit comments

Comments
 (0)