Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
110 changes: 110 additions & 0 deletions ST-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# 📚 ArduinoCore-API for STM32duino

> **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)

---

## 🎯 Purpose

This repository is a **fork** that contains **only** the official Arduino API and hardware-independent code.

**Main Goal:** Simplify Arduino API integration into STM32duino via a **git submodule**.

---

## 📦 What's Included?

✅ Arduino API official files (`api/` folder)

❌ Elements Removed
- Folders `test/`

---

## 🚀 Using as a Submodule

### 1️⃣ Add the Submodule

In your `Arduino_Core_STM32` repository, run:

```bash
# Add this repository as a submodule
git submodule add https://github.com/YOUR_USERNAME/ArduinoCore-API.git cores/arduino/ArduinoCore-API

# Initialize and update
git submodule update --init --recursive
```

---

## 📋 Changelog

### Version 1.0 (Initial)
- ✅ Extract `api/` folder from `arduino/ArduinoCore-API`
- ✅ Remove all non-API folders
- ✅ Prepare for use as submodule

---

## 🔗 Official Resources

| Resource | Link |
|----------|------|
| **Official ArduinoCore-API** | https://github.com/arduino/ArduinoCore-API |
| **STM32duino** | https://github.com/stm32duino/Arduino_Core_STM32 |

---

## 📝 License

This repository is a fork of `arduino/ArduinoCore-API` and maintains the **same license** (LGPL 2.1+).

See the `LICENSE` file in the repository root for details.

---

## 💡 Important Notes

### ✅ Advantages of Using a Submodule

- **Traceability**: Know exactly which version of the API you're using
- **Easy Updates**: Simple `git submodule update` to sync
- **Isolation**: API stays in its own code branch
- **Compatibility**: STM32-specific modifications remain separate

### ⚠️ Points to Consider

- **After Clone**: Run `git submodule update --init --recursive`

---

## 📊 Project Information

| Property | Value |
|----------|-------|
| **Type** | fork |
| **Use Case** | Submodule for STM32duino |
| **Language** | C/C++ |
| **License** | LGPL 2.1+ |
| **Original Repository** | https://github.com/arduino/ArduinoCore-API |
| **Compatible With** | |

---

## ✨ Quick Start

### Clone with Submodule

```bash
git clone --recurse-submodules https://github.com/stm32duino/Arduino_Core_STM32.git
```

### Update Submodule

```bash
git submodule update --remote
```

---

**Last Updated:** December 15, 2025
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
19 changes: 0 additions & 19 deletions test/.gitignore

This file was deleted.

158 changes: 0 additions & 158 deletions test/CMakeLists.txt

This file was deleted.

32 changes: 0 additions & 32 deletions test/include/MillisFake.h

This file was deleted.

31 changes: 0 additions & 31 deletions test/include/PrintMock.h

This file was deleted.

35 changes: 0 additions & 35 deletions test/include/PrintableMock.h

This file was deleted.

Loading