|
| 1 | +# 📚 ArduinoCore-API for STM32duino |
| 2 | + |
| 3 | +> **Fork** of [`arduino/ArduinoCore-API`](https://github.com/arduino/ArduinoCore-API) — Designed to be used as a **Git submodule** in [`stm32duino/Arduino_Core_STM32`](https://github.com/stm32duino/Arduino_Core_STM32) |
| 4 | +
|
| 5 | +--- |
| 6 | + |
| 7 | +## 🎯 Purpose |
| 8 | + |
| 9 | +This repository is a **fork** that contains **only** the official Arduino API and hardware-independent code. |
| 10 | + |
| 11 | +**Main Goal:** Simplify Arduino API integration into STM32duino via a **git submodule**. |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## 📦 What's Included? |
| 16 | + |
| 17 | +✅ Arduino API official files (`api/` folder) |
| 18 | + |
| 19 | +❌ Elements Removed |
| 20 | +- Folders `test/` |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +## 🚀 Using as a Submodule |
| 25 | + |
| 26 | +### 1️⃣ Add the Submodule |
| 27 | + |
| 28 | +In your `Arduino_Core_STM32` repository, run: |
| 29 | + |
| 30 | +```bash |
| 31 | +# Add this repository as a submodule |
| 32 | +git submodule add https://github.com/YOUR_USERNAME/ArduinoCore-API.git cores/arduino/ArduinoCore-API |
| 33 | + |
| 34 | +# Initialize and update |
| 35 | +git submodule update --init --recursive |
| 36 | +``` |
| 37 | + |
| 38 | +--- |
| 39 | + |
| 40 | +## 📋 Changelog |
| 41 | + |
| 42 | +### Version 1.0 (Initial) |
| 43 | +- ✅ Extract `api/` folder from `arduino/ArduinoCore-API` |
| 44 | +- ✅ Remove all non-API folders |
| 45 | +- ✅ Prepare for use as submodule |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +## 🔗 Official Resources |
| 50 | + |
| 51 | +| Resource | Link | |
| 52 | +|----------|------| |
| 53 | +| **Official ArduinoCore-API** | https://github.com/arduino/ArduinoCore-API | |
| 54 | +| **STM32duino** | https://github.com/stm32duino/Arduino_Core_STM32 | |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## 📝 License |
| 59 | + |
| 60 | +This repository is a fork of `arduino/ArduinoCore-API` and maintains the **same license** (LGPL 2.1+). |
| 61 | + |
| 62 | +See the `LICENSE` file in the repository root for details. |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +## 💡 Important Notes |
| 67 | + |
| 68 | +### ✅ Advantages of Using a Submodule |
| 69 | + |
| 70 | +- **Traceability**: Know exactly which version of the API you're using |
| 71 | +- **Easy Updates**: Simple `git submodule update` to sync |
| 72 | +- **Isolation**: API stays in its own code branch |
| 73 | +- **Compatibility**: STM32-specific modifications remain separate |
| 74 | + |
| 75 | +### ⚠️ Points to Consider |
| 76 | + |
| 77 | +- **After Clone**: Run `git submodule update --init --recursive` |
| 78 | + |
| 79 | +--- |
| 80 | + |
| 81 | +## 📊 Project Information |
| 82 | + |
| 83 | +| Property | Value | |
| 84 | +|----------|-------| |
| 85 | +| **Type** | fork | |
| 86 | +| **Use Case** | Submodule for STM32duino | |
| 87 | +| **Language** | C/C++ | |
| 88 | +| **License** | LGPL 2.1+ | |
| 89 | +| **Original Repository** | https://github.com/arduino/ArduinoCore-API | |
| 90 | +| **Compatible With** | | |
| 91 | + |
| 92 | +--- |
| 93 | + |
| 94 | +## ✨ Quick Start |
| 95 | + |
| 96 | +### Clone with Submodule |
| 97 | + |
| 98 | +```bash |
| 99 | +git clone --recurse-submodules https://github.com/stm32duino/Arduino_Core_STM32.git |
| 100 | +``` |
| 101 | + |
| 102 | +### Update Submodule |
| 103 | + |
| 104 | +```bash |
| 105 | +git submodule update --remote |
| 106 | +``` |
| 107 | + |
| 108 | +--- |
| 109 | + |
| 110 | +**Last Updated:** December 15, 2025 |
0 commit comments