docs: shorten tag release example in AGENTS.md

This commit is contained in:
2026-06-15 00:45:08 +02:00
parent 37b3d333cd
commit e4f4ca722d
+4 -32
View File
@@ -111,46 +111,18 @@ Use annotated tags for releases. Write the release notes to a temporary
file, then use it as the tag message. Do **not** commit the release
notes file.
Write release notes:
Write release notes (see previous tags for style reference):
```sh
cat > RELEASES.md << 'EOF'
# Releases
## 0.1.0 (2026-06-15)
## 0.2.0 (2026-01-01)
Initial release. Windows-only support.
Short summary.
### Library (`celrs`)
- **CRSF protocol**: CRC8/DVB-S2 validation, frame parsing, and frame
construction (RC channels, device ping, parameter read/write).
- **Telemetry decoders**: GPS, battery, link stats, attitude, flight
mode, vario, barometric altitude, airspeed, heartbeat, RPM,
temperature, voltages, ESC, and more.
- **Streaming parser**: incremental frame extraction from raw byte
streams with CRC validation.
- **Parameter protocol**: device ping, parameter read/write, and
TX power configuration by enumerating ELRS parameters.
- **Serial port abstraction**: open/close/read/write with baud-rate
probing (handles CP210x chips that cannot hit 921600 exactly),
port listing, and auto-detection of ELRS-like devices.
- **Logger**: level-filtering logger (debug/info/warn/error) with
a stdout sink.
### Tools
- **`telemetry`**: live dashboard that connects to an ELRS TX module
and displays link quality (RSSI, LQ, SNR, power), battery (voltage,
current, capacity, percentage), IMU attitude, flight mode, and a
frame-type breakdown. Supports auto-detect, `--list`, `--port`,
and `--baudrate` options.
### Notes
- Platform support: **Windows only** (via MinGW/MSVC on CMake + Ninja).
- Built against C23; tested with GCC 14+ and Clang 18+.
- Dependencies (Unity, CMock) are fetched automatically at configure
time. No manual setup required.
- **Feature**: description.
EOF
```