1
0
mirror of https://github.com/arduino/Arduino.git synced 2024-12-01 12:24:14 +01:00
Arduino/README.md

98 lines
3.9 KiB
Markdown
Raw Normal View History

2019-07-29 20:47:24 +02:00
<p align="center">
<img src="http://content.arduino.cc/brand/arduino-color.svg" width="50%" />
</p>
2014-01-29 21:57:29 +01:00
2019-07-29 20:47:24 +02:00
Arduino is an open-source physical computing platform based on a simple I/O
board and a development environment that implements the Processing/Wiring
language. Arduino can be used to develop stand-alone interactive objects or
2016-02-24 15:37:25 +01:00
can be connected to software on your computer (e.g. Flash, Processing and MaxMSP).
The boards can be assembled by hand or purchased preassembled; the open-source
2019-07-29 20:47:24 +02:00
IDE can be downloaded for free at [https://arduino.cc](https://www.arduino.cc/en/Main/Software)
![Github](https://img.shields.io/github/v/release/arduino/Arduino)
2019-07-29 20:47:24 +02:00
## More info at
2019-07-29 20:47:24 +02:00
- [Our website](https://www.arduino.cc/)
2019-07-29 20:47:24 +02:00
- [The forums](https://forum.arduino.cc/)
2013-10-23 18:39:19 +02:00
2019-07-29 20:47:24 +02:00
- Follow us on [Twitter](https://twitter.com/arduino)
- And like us at [Facebook](https://www.facebook.com/official.arduino)
## Bug reports and technical discussions
- To report a *bug* in the software or to request *a simple enhancement* go to [Github Issues](https://github.com/arduino/Arduino/issues)
- More complex requests and technical discussion should go on the [Arduino Developers
mailing list](https://groups.google.com/a/arduino.cc/forum/#!forum/developers)
- If you're interested in modifying or extending the Arduino software, we strongly
suggest discussing your ideas on the
[Developers mailing list](https://groups.google.com/a/arduino.cc/forum/#!forum/developers)
*before* starting to work on them.
That way you can coordinate with the Arduino Team and others,
2013-10-23 18:39:19 +02:00
giving your work a higher chance of being integrated into the official release
2021-03-09 02:51:33 +01:00
### Security
If you think you found a vulnerability or other security-related bug in this project, please read our
[security policy](https://github.com/arduino/Arduino/security/policy) and report the bug to our Security Team 🛡️
Thank you!
e-mail contact: security@arduino.cc
2019-07-29 20:47:24 +02:00
## Installation
Detailed instructions for installation in popular operating systems can be found at:
- [Linux](https://www.arduino.cc/en/Guide/Linux) (see also the [Arduino playground](https://playground.arduino.cc/Learning/Linux))
- [macOS](https://www.arduino.cc/en/Guide/macOS)
2019-07-29 20:47:24 +02:00
- [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>
2019-07-29 20:47:24 +02:00
## Credits
Arduino is an open source project, supported by many.
2015-09-29 14:16:12 +02:00
The Arduino team is composed of Massimo Banzi, David Cuartielles, Tom Igoe
and David A. Mellis.
Arduino uses
[GNU avr-gcc toolchain](https://gcc.gnu.org/wiki/avr-gcc),
2015-09-29 14:16:12 +02:00
[GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded),
[avr-libc](https://www.nongnu.org/avr-libc/),
[avrdude](https://www.nongnu.org/avrdude/),
2015-09-29 14:16:12 +02:00
[bossac](http://www.shumatech.com/web/products/bossa),
[openOCD](http://openocd.org/)
2018-01-10 18:28:47 +01:00
and code from [Processing](https://www.processing.org)
2015-09-29 14:16:12 +02:00
and [Wiring](http://wiring.org.co).
Icon and about image designed by [ToDo](https://www.todo.to.it/)