From a2ff80c191eeab2151b85dfc69d840c87cc40874 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sun, 12 Jul 2020 10:15:20 -0700 Subject: [PATCH] Mention ArduinoCore-API in the "Cores" section of the platform specification 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. --- docs/platform-specification.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/platform-specification.md b/docs/platform-specification.md index 3f96c7f3858..428e81c6568 100644 --- a/docs/platform-specification.md +++ b/docs/platform-specification.md @@ -407,6 +407,17 @@ or if the RTOS core is needed, to: In any case the contents of the selected core folder are compiled and the core folder path is added to the include files search path. +#### ArduinoCore-API + +Although much of the implementation of a core is architecture-specific, the standardized core API and the hardware +independent components should be the same for every Arduino platform. In order to free platform authors from the burden +of individually maintaining duplicates of this common code, Arduino has published it in a dedicated repository from +which it may easily be shared by all platforms. In addition to significantly reducing the effort required to write and +maintain a core, ArduinoCore-API assists core authors in providing the unprecedented level of portability between +platforms that is a hallmark of the Arduino project. + +See the [arduino/ArduinoCore-API repository](https://github.com/arduino/ArduinoCore-API) for more information. + ### Core Variants Sometimes a board needs some tweaking on default core configuration (different pin mapping is a typical example). A core