Skip to content

Commit 286d1a8

Browse files
committed
Add initial read me (based on the SAMD core read me)
1 parent c3846ee commit 286d1a8

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

Diff for: README.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Arduino Core for ATMEGA4809 CPU
2+
3+
This repository contains the source code and configuration files of the Arduino Core
4+
for Microchip's ATMEGA4809 processor (used on the Arduino Uno WiFi Rev2 boards).
5+
6+
## Installation on Arduino IDE
7+
8+
This core is available as a package in the Arduino IDE cores manager.
9+
Just open the "Boards Manager" and install the package called:
10+
11+
"Arduino megaAVR Boards"
12+
13+
## Support
14+
15+
There is a dedicated section of the Arduino Forum for general discussion and project assistance:
16+
17+
http://forum.arduino.cc/index.php?board=126.0
18+
19+
## Bugs or Issues
20+
21+
If you find a bug you can submit an issue here on github:
22+
23+
https://github.com/arduino/ArduinoCore-megaavr/issues
24+
25+
Before posting a new issue, please check if the same problem has been already reported by someone else
26+
to avoid duplicates.
27+
28+
## Contributions
29+
30+
Contributions are always welcome. The preferred way to receive code cotribution is by submitting a
31+
Pull Request on github.
32+
33+
## Developing
34+
35+
1. Create an `<SKETCHBOOK>/hardware/arduino` folder. Where `<SKETCHBOOK>` is the location of your
36+
Arduino sketchbook.
37+
1. Change directories: `cd <SKETCHBOOK>/hardware/arduino`
38+
1. Clone this repo: `git clone https://github.com/arduino/ArduinoCore-megaavr.git megaavr`
39+
1. Change directories: `cd megaavr/cores/arduino`
40+
1. Copy or symlink the `api` folder from the [ArduinoCore-API](https://github.com/arduino/ArduinoCore-API) repo.
41+
1. Restart the IDE
42+
43+
## License and credits
44+
45+
This core has been developed by Arduino SA in collaboration with Microchip.
46+
47+
```
48+
Copyright (c) 2018 Arduino SA. All right reserved.
49+
50+
This library is free software; you can redistribute it and/or
51+
modify it under the terms of the GNU Lesser General Public
52+
License as published by the Free Software Foundation; either
53+
version 2.1 of the License, or (at your option) any later version.
54+
55+
This library is distributed in the hope that it will be useful,
56+
but WITHOUT ANY WARRANTY; without even the implied warranty of
57+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
58+
See the GNU Lesser General Public License for more details.
59+
60+
You should have received a copy of the GNU Lesser General Public
61+
License along with this library; if not, write to the Free Software
62+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
63+
```

0 commit comments

Comments
 (0)