Skip to content

Commit dc0dda1

Browse files
release: v0.6.0
1 parent 53686b4 commit dc0dda1

18 files changed

Lines changed: 35 additions & 230 deletions

File tree

CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
# include(FetchContent)
1818
# FetchContent_Declare(midi2
1919
# GIT_REPOSITORY https://github.com/sauloverissimo/midi2.git
20-
# GIT_TAG v0.5.0)
20+
# GIT_TAG v0.6.0)
2121
# FetchContent_MakeAvailable(midi2)
2222
# endif()
2323
# endif()
@@ -50,7 +50,7 @@ if(ESP_PLATFORM)
5050
return()
5151
endif()
5252

53-
project(midi2 VERSION 0.5.0 LANGUAGES C)
53+
project(midi2 VERSION 0.6.0 LANGUAGES C)
5454

5555
# GNUInstallDirs has to come before target_include_directories so that
5656
# $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}> evaluates to the real

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -181,14 +181,14 @@ Install via Library Manager (search `midi2`, click Install) or manually drop the
181181
#include <midi2.h>
182182
```
183183

184-
Two example sketches under `examples/` (`BasicUsage`, `CIDiscovery`) appear in the IDE's File > Examples menu after install. Validated on Arduino UNO (AVR) and Teensy 4.1.
184+
Two example sketches under `examples/` (`basic-usage`, `ci-discovery`) appear in the IDE's File > Examples menu after install. Validated on Arduino UNO (AVR) and Teensy 4.1.
185185

186186
### PlatformIO
187187

188188
`platformio.ini`:
189189

190190
```ini
191-
lib_deps = sauloverissimo/midi2 @ ^0.5.0
191+
lib_deps = sauloverissimo/midi2 @ ^0.6.0
192192
```
193193

194194
Library Manager pulls the same `src/` modular layout via `library.json` (`srcDir = src`).
@@ -200,7 +200,7 @@ Published on the [ESP Component Registry](https://components.espressif.com/compo
200200
```yaml
201201
dependencies:
202202
idf: ">=5.0"
203-
sauloverissimo/midi2: ">=0.5.0"
203+
sauloverissimo/midi2: ">=0.6.0"
204204
```
205205
206206
`idf.py reconfigure` drops the component into `managed_components/midi2/`. The `if(ESP_PLATFORM)` gate in `CMakeLists.txt` routes ESP-IDF builds to `idf_component_register` with the modular `src/midi2_*.c` set, so the same source serves IDF, Arduino, PlatformIO, and native CMake without forks.
@@ -214,7 +214,7 @@ manifest:
214214
projects:
215215
- name: midi2
216216
url: https://github.com/sauloverissimo/midi2
217-
revision: v0.5.0
217+
revision: v0.6.0
218218
path: modules/lib/midi2
219219
```
220220

@@ -263,10 +263,9 @@ midi2_msg.h Always needed. Header-only.
263263

264264
## Examples
265265

266-
Pedagogical sketches and a flash-ready Zephyr hardware recipe live under [`examples/`](examples). See [`examples/README.md`](examples/README.md) for the index.
266+
Pedagogical sketches and a flash-ready Zephyr hardware recipe live under [`examples/`](examples).
267267

268-
- [`examples/basic_usage.c`](examples/basic_usage.c): host C99 walkthrough of construction, dispatch, `midi2_proc` and CI Discovery.
269-
- [`examples/BasicUsage/`](examples/BasicUsage) and [`examples/CIDiscovery/`](examples/CIDiscovery): Arduino sketches for the same surfaces, runnable on Teensy 4.x and AVR.
268+
- [`examples/basic-usage/`](examples/basic-usage) and [`examples/ci-discovery/`](examples/ci-discovery): Arduino sketches covering UMP construction, scaling, typed dispatch, `midi2_proc`, and MIDI-CI Discovery. Runnable on Teensy 4.x and AVR.
270269
- [`examples/rpi-pico-device-zephyr/`](examples/rpi-pico-device-zephyr): flash-ready Raspberry Pi Pico USB MIDI 2.0 device with a 14-scene UMP showcase and a MIDI-CI responder.
271270

272271
## Architecture

dist/midi2.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* THE SOFTWARE.
2323
*/
2424

25-
/* Auto-generated from midi2 v0.5.0 (reproducible: no timestamp)
25+
/* Auto-generated from midi2 v0.6.0 (reproducible: no timestamp)
2626
* https://github.com/sauloverissimo/midi2
2727
*
2828
* Portable MIDI 2.0 library (C99, zero dependencies)

dist/midi2.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* THE SOFTWARE.
2323
*/
2424

25-
/* Auto-generated from midi2 v0.5.0 (reproducible: no timestamp)
25+
/* Auto-generated from midi2 v0.6.0 (reproducible: no timestamp)
2626
* https://github.com/sauloverissimo/midi2
2727
*
2828
* Portable MIDI 2.0 library (C99, zero dependencies)

docs/wiki/Getting-Started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ The fastest path depends on the build system. See the [Integration Guide](Integr
1515
|---|---|
1616
| Arduino IDE | Library Manager, search `midi2`, click Install |
1717
| arduino-cli | `arduino-cli lib install midi2` |
18-
| PlatformIO | `lib_deps = sauloverissimo/midi2 @ ^0.5.0` |
19-
| ESP-IDF | `sauloverissimo/midi2: ">=0.5.0"` in `idf_component.yml` |
18+
| PlatformIO | `lib_deps = sauloverissimo/midi2 @ ^0.6.0` |
19+
| ESP-IDF | `sauloverissimo/midi2: ">=0.6.0"` in `idf_component.yml` |
2020
| Zephyr | west manifest entry + `CONFIG_MIDI2=y` (see Integration Guide) |
21-
| CMake | `FetchContent_Declare(midi2 GIT_TAG v0.5.0)` |
21+
| CMake | `FetchContent_Declare(midi2 GIT_TAG v0.6.0)` |
2222
| Manual vendor | drop `dist/midi2.{h,c}` from a release into your tree |
2323

2424
For local development:

docs/wiki/Home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The portable MIDI 2.0 UMP library: C99, zero dependencies, zero allocation. Runs
2626
## Quick links
2727

2828
- **Repository:** [github.com/sauloverissimo/midi2](https://github.com/sauloverissimo/midi2)
29-
- **Latest release:** [v0.5.0](https://github.com/sauloverissimo/midi2/releases/latest)
29+
- **Latest release:** [v0.6.0](https://github.com/sauloverissimo/midi2/releases/latest)
3030
- **License:** MIT
3131
- **Distribution:** Arduino Library Manager, PlatformIO Registry, ESP-IDF Component Manager, Zephyr west module, CMake `find_package` / `FetchContent`
3232
- **Tests:** 350 passing across 8 suites, 12 CI jobs (gcc / clang / MSVC / Apple clang / x86 32-bit / ASan + UBSan / ARM Cortex-M / Cortex-A / RISC-V / AVR / ESP32 / Zephyr native_sim) plus a CMake matrix on Linux + macOS + Windows

docs/wiki/Integration-Guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ arduino-cli lib update-index
1111
arduino-cli lib install midi2
1212
```
1313

14-
In the IDE, search `midi2` in the Library Manager and click Install. Two reference sketches appear under **File > Examples > midi2**: `BasicUsage` and `CIDiscovery`. Sketch include:
14+
In the IDE, search `midi2` in the Library Manager and click Install. Two reference sketches appear under **File > Examples > midi2**: `basic-usage` and `ci-discovery`. Sketch include:
1515

1616
```cpp
1717
#include <midi2.h>
@@ -20,7 +20,7 @@ In the IDE, search `midi2` in the Library Manager and click Install. Two referen
2020
## PlatformIO
2121

2222
```ini
23-
lib_deps = sauloverissimo/midi2 @ ^0.5.0
23+
lib_deps = sauloverissimo/midi2 @ ^0.6.0
2424
```
2525

2626
The Registry resolves the modular `src/*.c` layout via `library.json` (`srcDir = src`).
@@ -32,7 +32,7 @@ The Registry resolves the modular `src/*.c` layout via `library.json` (`srcDir =
3232
```yaml
3333
dependencies:
3434
idf: ">=5.0"
35-
sauloverissimo/midi2: ">=0.5.0"
35+
sauloverissimo/midi2: ">=0.6.0"
3636
```
3737
3838
`idf.py reconfigure` drops the component into `managed_components/midi2/`. ESP-IDF picks the directory up as a regular component because the top-level `CMakeLists.txt` detects `ESP_PLATFORM` and routes to `idf_component_register` with the modular `src/midi2_*.c` set.
@@ -46,7 +46,7 @@ manifest:
4646
projects:
4747
- name: midi2
4848
url: https://github.com/sauloverissimo/midi2
49-
revision: v0.5.0
49+
revision: v0.6.0
5050
path: modules/lib/midi2
5151
```
5252

@@ -62,12 +62,12 @@ CONFIG_MIDI2=y
6262

6363
```cmake
6464
if(NOT TARGET midi2)
65-
find_package(midi2 0.5.0 QUIET CONFIG)
65+
find_package(midi2 0.6.0 QUIET CONFIG)
6666
if(NOT midi2_FOUND)
6767
include(FetchContent)
6868
FetchContent_Declare(midi2
6969
GIT_REPOSITORY https://github.com/sauloverissimo/midi2.git
70-
GIT_TAG v0.5.0)
70+
GIT_TAG v0.6.0)
7171
FetchContent_MakeAvailable(midi2)
7272
endif()
7373
endif()

examples/README.md

Lines changed: 0 additions & 30 deletions
This file was deleted.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [midi2](../..) | BasicUsage
1+
# [midi2](../..) | basic-usage
22

33
Arduino sketch that exercises the four core surfaces of midi2 on any Arduino-compatible board. No MIDI transport required: the sketch builds messages, parses them, and prints decoded events over `Serial`.
44

@@ -19,7 +19,7 @@ Arduino IDE or arduino-cli, with the midi2 library installed:
1919
Sketch -> Include Library -> Manage Libraries -> midi2
2020
```
2121

22-
Or drop a clone of this repo into `~/Arduino/libraries/midi2/`. Open `BasicUsage.ino` and Upload.
22+
Or drop a clone of this repo into `~/Arduino/libraries/midi2/`. Open `basic-usage.ino` and Upload.
2323

2424
## Validated on
2525

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* midi2 BasicUsage example, Arduino sketch.
2+
* midi2 basic-usage example, Arduino sketch.
33
*
44
* Demonstrates the four core surfaces of the library on any
55
* Arduino-compatible board:
@@ -57,7 +57,7 @@ void setup() {
5757
// Wait for USB CDC on boards where Serial is over USB.
5858
}
5959

60-
Serial.println("=== midi2 BasicUsage ===");
60+
Serial.println("=== midi2 basic-usage ===");
6161

6262
// -------- 1. Build messages --------
6363

0 commit comments

Comments
 (0)