diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 36 insertions, 7 deletions
@@ -1,18 +1,47 @@ # soundbox-app -This is an app to use [soundbox][1] devices. The current version is only a web -radio player as a proof of concept. Future versions will add the audio -streaming to soundbox devices. +This is a graphical application to use [soundbox][1] devices. It is able to +stream from a web radio URL to one or multiple soundbox devices simultaneously. ## Usage -The [Go tool][2] and the [mpv media player][3] are required to use the app. It -can be build and started like this: +A configuration file like this has to be placed at +`~/.config/soundbox/config.json` for the application to work: ``` -go run main.go +{ + "soundboxes": [ + { + "name": "sb1", + "mac": "00:00:5e:00:53:01", + "enabled": true + }, + { + "name": "sb2", + "mac": "00:00:5e:00:53:02", + "enabled": false + } + ], + "urls": [ + { + "name": "Radio One", + "url": "https://example.org/radio/one.mp3" + }, + { + "name": "Radio Two", + "url": "https://example.org/radio/two.mp3" + } + ] +} +``` + +The [Go][2] and the [ffmpeg][3] tools are required to use the app. It can be +build and started like this: + +``` +go run ./... ``` [1]: https://xengineering.eu/git/soundbox [2]: https://go.dev -[3]: https://mpv.io +[3]: https://ffmpeg.org |