Skip to content

Commit 0641cd7

Browse files
matthijskooijmancmaglie
authored andcommitted
README: Add links to libraries, cores and building/testing docs
1 parent 1c9678f commit 0641cd7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

+26
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,32 @@ Detailed instructions for installation in popular operating systems can be found
4040
- [macOS](https://www.arduino.cc/en/Guide/MacOSX)
4141
- [Windows](https://www.arduino.cc/en/Guide/Windows)
4242

43+
## Contents of this repository
44+
45+
This repository contains just the code for the Arduino IDE itself.
46+
Originally, it also contained the AVR and SAM Arduino core and libraries
47+
(i.e. the code that is compiled as part of a sketch and runs on the
48+
actual Arduino device), but those have been moved into their own
49+
repositories. They are still automatically downloaded as part of the
50+
build process and included in built releases, though.
51+
52+
The repositories for these extra parts can be found here:
53+
- Non-core specific Libraries are listed under: <https://github.com/arduino-libraries/>
54+
(and also a few other places, see `build/build.xml`).
55+
56+
- The AVR core can be found at: <https://github.com/arduino/ArduinoCore-avr>
57+
58+
- Other cores are not included by default but installed through the
59+
board manager. Their repositories can also be found under
60+
<https://github.com/arduino/>.
61+
62+
## Building and testing
63+
64+
Instructions for building the IDE and running unit tests can be found on
65+
the wiki:
66+
- <https://github.com/arduino/Arduino/wiki/Building-Arduino>
67+
- <https://github.com/arduino/Arduino/wiki/Testing-Arduino>
68+
4369
## Credits
4470

4571
Arduino is an open source project, supported by many.

0 commit comments

Comments
 (0)