From 80ab5a085cb8f74eb02bd906d35f70a0f6c68ee1 Mon Sep 17 00:00:00 2001 From: Cristian Maglie <c.maglie@bug.st> Date: Mon, 6 Jul 2015 17:22:09 +0200 Subject: [PATCH] Added a basic readme --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..d90c4504 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# Arduino Core for SAMD21 CPU + +This repository containts the source code and configuration files of the Arduino Core +for Atmel's SAMD21 processor (used on the Arduino Zero board). + +## Installation on Arduino IDE + +Just open the "Boards Manager" and install the package called: + +``` +Arduino SAMD Boards (32-bit ARM Cortex-M0+) +``` + +## Hourly builds + +This repository is under a CI system that every hour checks if there are updates and +builds a release for testing (the so called "Hourly builds"). + +The hourly builds are available through Boards Manager. If you want to install them: + 1. Open the **Preferences** of the Arduino IDE. + 2. Add this URL `http://downloads.arduino.cc/Hourly/samd/package_samd-hourly-build_index.json` in the **Additional Boards Manager URLs** field, and click OK. + 3. Open the **Boards Manager** (menu Tools->Board->Board Manager...) + 4. Install **Arduino SAMD core - Hourly build** + 5. Select one of the boards under **SAMD Hourly build XX** in Tools->Board menu + 6. Compile/Upload as usual + +If you already installed an hourly build and you want to update it with the latest: + 1. Open the **Boards Manager** (menu Tools->Board->Board Manager...) + 2. Remove **Arduino SAMD core - Hourly build** + 3. Install again **Arduino SAMD core - Hourly build**, the Board Manager will download the latest build replacing the old one. + +## Support + +There is a dedicated section of the Arduino Forum for general discussion and project assistance: + +http://forum.arduino.cc/index.php?board=98.0 + +## Bugs or Issues + +If you find a bug you can submit an issue here on github: + +https://github.com/arduino/ArduinoCore-samd/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 cotribution is by submitting a +Pull Request on github. + +## License and credits + +``` + Copyright (c) 2015 Arduino LLC. All right reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the GNU Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +``` -- GitLab