README.md

Arduino-Core-Documentation

The repository is created to provide necessary documentation for the Arduino Cores.

Description

The Wiki of the Repository is dedicated to the Documentation. Please refer to the Table of Contents below for more detailed information.

Table of Contents

1. Introduction to Arduino Core

2. Introduction to Source files and the Building Process

   1. General Source Files
   2. Port-related Source Files
      • Digital Port Source File
      • Analog Port Source File
      • Other Port Related Files
   3. Timers/Timing Source Files
   4. Hardware Serial Source Files
   5. Wiring-related Source Files
   6. Others

3. Custom Core Design JSON File Creation

4. Architecture Configuration File: Description

• platform.txt
• boards.txt
• programmers.txt.

5. Building Process: Steps and Workflow

• Compilation
• Core Archive File Creation
• Linking Process
• Hex File Generation
• Binary Sketch Computation
• Preprocessing

6. Arduino Core Testing

• Online Method - JSON Url Creation.
• Offline Method - Addition of Arduino Core to the IDE.

Please refer to https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5-3rd-party-Hardware-specification for more details.

Contributing

Excerpt from Arduino Season of Docs Page

Document Arduino cores

How are Arduino cores done, and how to make them your own is something that we cover in a slightly superficial way on the Arduino website. We have increased the number of cores we have in our ecosystem over the years, but there is still little about the philosophy of why they are made the way they are. It would be interesting to have some documentation made on this topic, also for our own hardware architects to-be to understand what makes a board an Arduino one.