From 89833081ef18aea430b8943ab653dbbd510d43ce Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Mon, 8 Aug 2022 09:47:04 +0200 Subject: [PATCH] Document how to add the required link to ArduinoCore-API. (#676) * Document how to add the required link to ArduinoCore-API. Related to https://github.com/arduino/ArduinoCore-API/issues/96. * Update README.md Co-authored-by: per1234 * Update README.md Co-authored-by: per1234 * Update README.md Co-authored-by: per1234 * Update README.md Co-authored-by: per1234 Co-authored-by: per1234 --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index b8bcac199..b37a11f0f 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,33 @@ to avoid duplicates. Contributions are always welcome. The preferred way to receive code contribution is by submitting a Pull Request on github. +## Developing + +1. Clone the [ArduinoCore-API](https://github.com/arduino/ArduinoCore-API) repo to any convenient location: + ``` + git clone https://github.com/arduino/ArduinoCore-API.git + ``` +1. Create an `/hardware/arduino-git` folder, where `` is the location of your + Arduino sketchbook. +1. Change directories: + ``` + cd /hardware/arduino-git + ``` +1. Clone this repo: + ``` + git clone https://github.com/arduino/ArduinoCore-samd.git samd + ``` +1. Change directories: + ``` + cd samd/cores/arduino + ``` +1. Copy or symlink the `api` folder from the [ArduinoCore-API](https://github.com/arduino/ArduinoCore-API) repo: + ``` + ln -s /api . + ``` + where `` is the location where you've cloned the ArduinoCore-API repository to. +1. Restart the IDE. + ## Hourly builds This repository is under a Continuous Integration system that every hour checks if there are updates and