docs: Add README and set license to Public Domain

This commit is contained in:
Eddy 2026-05-09 09:38:48 +02:00
commit 578c7684bb

31
README.md Normal file
View file

@ -0,0 +1,31 @@
# M5StickCplus2 HelloWorld
This repository contains a simple "Hello World" example for the M5StickCplus2 device. It demonstrates the basic setup and operation of the hardware platform.
## 🚀 Getting Started
### Prerequisites
- M5StickCplus2 hardware
- Appropriate compiler and toolchain (e.g., PlatformIO or ESP-IDF)
### Installation
Clone this repository:
```bash
git clone https://your-repo-url.git
cd M5StickCplus2-HelloWorld
```
### Compiling and Running
The exact compilation and upload steps depend on your chosen development environment (e.g., PlatformIO).
**Example (PlatformIO):**
1. Ensure all dependencies are installed.
2. Build the project: `pio run`
3. Upload the compiled firmware to the M5StickCplus2: `pio run --target upload`
## Project Structure
- `src/`: Contains the main source code for the application.
- `README.md`: This file provides documentation for the project.
## License
This project is released under the Public Domain (CC0).