This is a template to create an Arduino Core (an Arduino port for a new board or platform).
This template is currently under development, so the code and documentation are not yet complete. Nevertheless, if you are creating a new Arduino Core, you can build on top of what is already here as a base, and go from there.
vendorname
Your Name
Arduino Core Template
template-arch
avr
, samd
, etc.Arduino Core Template Board One
Arduino Core Template Board Two
0.0.1
.github
: This folder contains a GitHub Action to do code style check usingcores
: This folder contains the Arduino Core C/C++ source code (the filesdocs
: This folder is not part of the Arduino Core, but it is used to becustom-tools
: This folder and its contents are not necessary for theboards.txt
: Defines the Arduino boards for this core.platform.txt
: Defines how the Arduino IDE/CLI use the tooling to builddocs/package_info.json
: This files is not packaged inside the Arduino Core,docs/README.md
file.programmers.txt
: Contains definitions to use external programmers, forkeywords.txt
: WIP.For development these are the instructions to install this Arduino Core from the GitHub repository:
SKETCHBOOK
directory, which depends on your Operating%USERPROFILE%\Documents\Arduino
~/Documents/Arduino
~/Arduino
SKETCHBOOK
subdirectory:
git clone https://github.com/carlosperate/ArduinoCore-Template.git <SKETCHBOOK_PATH>/hardware/vendorname/template/
cores/api
directory insidegit clone https://github.com/arduino/ArduinoCore-API.git
ln -s <ArduinoCore-API_PATH>/api <SKETCHBOOK_PATH>/hardware/vendorname/template/cores/template/api/
api
folder from<SKETCHBOOK_PATH>/hardware/vendorname/template/cores/template/api/
tools/board
menu.As this is just a template, it is not intended to be used directly by users. However, for your own release of an Arduino Core (based on this template, created from scratch, or from a different Core), these would an example of the user instructions:
https://carlosperate.github.io/ArduinoCore-Template/docs/package_YourName_ArduinoCoreTemplate_index.json
tools/board
menu.tools/board
menu.WIP - Include info about the API repo and why it is not included here.
The list itself is not yet updated, but will soon contain all items still left to implement.
Some of the features used in this template are not available in earlier version of the Arduino IDE, so the currently minimum version is: