mirror of
https://github.com/spalencsar/bearwave.git
synced 2026-07-06 14:24:14 +02:00
docs: prepare 1.0.4 release notes and CI test coverage
Document current version in README, add ctest instructions, update QML development paths, and run tests plus broader qmllint in CI.
This commit is contained in:
3
.github/workflows/build.yml
vendored
3
.github/workflows/build.yml
vendored
@@ -35,5 +35,6 @@ jobs:
|
|||||||
qt6-multimedia-ffmpeg
|
qt6-multimedia-ffmpeg
|
||||||
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
|
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
|
||||||
cmake --build build -j"$(nproc)"
|
cmake --build build -j"$(nproc)"
|
||||||
"$(/usr/lib/qt6/bin/qtpaths6 --query QT_INSTALL_BINS)/qmllint" src/qml/Main.qml
|
ctest --test-dir build --output-on-failure
|
||||||
|
"$(/usr/lib/qt6/bin/qtpaths6 --query QT_INSTALL_BINS)/qmllint" src/qml/Main.qml src/qml/components/*.qml src/qml/theme/BearTheme.qml
|
||||||
'
|
'
|
||||||
|
|||||||
@@ -34,7 +34,13 @@ cmake --install build --prefix "$HOME/.local"
|
|||||||
If you changed QML:
|
If you changed QML:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
qmllint src/qml/Main.qml
|
qmllint src/qml/Main.qml src/qml/components/*.qml src/qml/theme/BearTheme.qml
|
||||||
|
```
|
||||||
|
|
||||||
|
Run unit tests after backend changes:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ctest --test-dir build --output-on-failure
|
||||||
```
|
```
|
||||||
|
|
||||||
## Change Guidelines
|
## Change Guidelines
|
||||||
|
|||||||
20
README.md
20
README.md
@@ -9,6 +9,9 @@ BearWave is designed for fast station browsing, simple playback controls, favori
|
|||||||

|

|
||||||

|

|
||||||

|

|
||||||
|

|
||||||
|
|
||||||
|
**Current release:** [1.0.4](CHANGELOG.md#104---2026-06-20) (2026-06-20) — security hardening, playback/tray/MPRIS fixes, modular QML UI.
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
@@ -214,6 +217,16 @@ cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
|
|||||||
cmake --build build -j"$(nproc)"
|
cmake --build build -j"$(nproc)"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
|
||||||
|
From the build directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ctest --test-dir build --output-on-failure
|
||||||
|
```
|
||||||
|
|
||||||
|
This runs backend unit tests for playback navigation, API race handling, and manual station URL validation.
|
||||||
|
|
||||||
## Runtime Requirements
|
## Runtime Requirements
|
||||||
|
|
||||||
- Linux desktop session
|
- Linux desktop session
|
||||||
@@ -323,14 +336,17 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for local build and review expectations.
|
|||||||
|
|
||||||
## Development Notes
|
## Development Notes
|
||||||
|
|
||||||
- main UI: `src/qml/Main.qml`
|
- main UI shell: `src/qml/Main.qml`
|
||||||
|
- QML components: `src/qml/components/` (navigation, search, station cards, player bar, dialogs)
|
||||||
|
- theme singleton: `src/qml/theme/BearTheme.qml`
|
||||||
- backend orchestration: `src/radiobackend.cpp`
|
- backend orchestration: `src/radiobackend.cpp`
|
||||||
- stream playback: `src/bearplayer.cpp`
|
- stream playback: `src/bearplayer.cpp`
|
||||||
- API layer: `src/radiobrowser.cpp`
|
- API layer: `src/radiobrowser.cpp`
|
||||||
- MPRIS adapter: `src/mprisadaptor.cpp`
|
- MPRIS adapter: `src/mprisadaptor.cpp`
|
||||||
- desktop notifications: `src/notificationmanager.cpp`
|
- desktop notifications: `src/notificationmanager.cpp`
|
||||||
|
- unit tests: `tests/`
|
||||||
|
|
||||||
For contributor and agent guardrails, see `AGENTS.md`.
|
See [CHANGELOG.md](CHANGELOG.md) for release history. For contributor and agent guardrails, see `AGENTS.md`.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user