diff options
author | Matthijs Kooijman <matthijs@stdin.nl> | 2020-05-07 19:33:26 +0300 |
---|---|---|
committer | Cristian Maglie <c.maglie@bug.st> | 2020-05-11 16:33:32 +0300 |
commit | 0641cd74cc5b38def9bd3f004cf2805601b35501 (patch) | |
tree | c5a35e9c3b1c67c8c90933b610a3435926f3cb80 /README.md | |
parent | 1c9678f21dd037db107ec7088b82511c484b6424 (diff) |
README: Add links to libraries, cores and building/testing docs
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
@@ -40,6 +40,32 @@ Detailed instructions for installation in popular operating systems can be found - [macOS](https://www.arduino.cc/en/Guide/MacOSX) - [Windows](https://www.arduino.cc/en/Guide/Windows) +## Contents of this repository + +This repository contains just the code for the Arduino IDE itself. +Originally, it also contained the AVR and SAM Arduino core and libraries +(i.e. the code that is compiled as part of a sketch and runs on the +actual Arduino device), but those have been moved into their own +repositories. They are still automatically downloaded as part of the +build process and included in built releases, though. + +The repositories for these extra parts can be found here: +- Non-core specific Libraries are listed under: <https://github.com/arduino-libraries/> + (and also a few other places, see `build/build.xml`). + +- The AVR core can be found at: <https://github.com/arduino/ArduinoCore-avr> + +- Other cores are not included by default but installed through the + board manager. Their repositories can also be found under + <https://github.com/arduino/>. + +## Building and testing + +Instructions for building the IDE and running unit tests can be found on +the wiki: +- <https://github.com/arduino/Arduino/wiki/Building-Arduino> +- <https://github.com/arduino/Arduino/wiki/Testing-Arduino> + ## Credits Arduino is an open source project, supported by many. |