From 90462901a3f774684fa1d819a7b4394b5cebca16 Mon Sep 17 00:00:00 2001 From: Ashutosh Pandey Date: Mon, 22 Jun 2020 09:13:55 +0530 Subject: [PATCH] Create README.md Unlike https://github.com/arduino/ArduinoCore-samd this repository did not have a README.md file, so I created one along the same lines. It can be updated later with more details about the contents of the folder in the repository. --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..14f101129 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Arduino Core for AVR microcontroller + +This repository contains the source code and configuration files of the Arduino Core for Atmel's AVR microcontroller used on the Arduino Yún, Uno, Uno WiFi, Diecimila, Nano, Mega, MegaADK, Leonardo, Leonardo Ethernet, Micro, Esplora, Min, Ethernet, Fio, BT, LilyPadUSB, Lilypad, Pro, ATMegaNG, Robot Control, Robot Motor, Gemma, Yún Mini and Industrial 101. + +## Installation on Arduino IDE +This core comes preinstalled by default in the Arduino IDE. If you need to explicitly install the core or update it, Just open the "Boards Manager" under Tools --> Board --> Boards Manager and install the package called: + +"Arduino AVR Boards" + +## Installation on Arduino CLI + +This core can be installed on [arduino-cli](https://arduino.github.io/arduino-cli/latest/) with the command: + + $ arduino-cli core install arduino:avr + +## Support +There is a dedicated section of the Arduino Forum for general discussion and project assistance: + +[https://forum.arduino.cc/index.php?board=1.0](https://forum.arduino.cc/index.php?board=1.0) + +Before posting, please check the other sections of the forum to make sure if your query is better suited for another section of the forum. + +## Bugs or Issues +If you find a bug you can submit an issue here on github: + +[https://github.com/arduino/ArduinoCore-avr/issues](https://github.com/arduino/ArduinoCore-avr/issues) + +Before posting a new issue, please check if the same problem has been already reported by someone else to avoid duplicates. + +## Contributions + +Contributions are always welcome. The preferred way to receive code contribution is by submitting a Pull Request on github