Skip to content

Commit c95810c

Browse files
authored
Mention ArduinoCore-API in the "Cores" section of the platform specification (#826)
ArduinoCore-API is an important resource for core authors, so it is beneficial to alert the readers of this section of the Arduino platform specification to its existence.
1 parent ec8d4f1 commit c95810c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Diff for: docs/platform-specification.md

+11
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,17 @@ or if the RTOS core is needed, to:
407407
In any case the contents of the selected core folder are compiled and the core folder path is added to the include files
408408
search path.
409409

410+
#### ArduinoCore-API
411+
412+
Although much of the implementation of a core is architecture-specific, the standardized core API and the hardware
413+
independent components should be the same for every Arduino platform. In order to free platform authors from the burden
414+
of individually maintaining duplicates of this common code, Arduino has published it in a dedicated repository from
415+
which it may easily be shared by all platforms. In addition to significantly reducing the effort required to write and
416+
maintain a core, ArduinoCore-API assists core authors in providing the unprecedented level of portability between
417+
platforms that is a hallmark of the Arduino project.
418+
419+
See the [arduino/ArduinoCore-API repository](https://github.com/arduino/ArduinoCore-API) for more information.
420+
410421
### Core Variants
411422

412423
Sometimes a board needs some tweaking on default core configuration (different pin mapping is a typical example). A core

0 commit comments

Comments
 (0)