lonelyradio/README.md
Ivan Bushchik 0afbed5758
v0.2.2: Add monolib docs and readme
Signed-off-by: Ivan Bushchik <ivabus@ivabus.dev>
2024-03-15 19:36:24 +03:00

46 lines
922 B
Markdown

# lonelyradio
> TCP radio for singles
Radio that uses unencrypted TCP socket for broadcasting tagged audio data.
Decodes audio streams using [symphonia](https://github.com/pdeljanov/Symphonia).
## Install
```shell
cargo install lonelyradio
```
## Build
```shell
cargo build -r
```
## Run
```
lonelyradio [-a <ADDRESS:PORT>] <MUSIC_FOLDER> [-p] [-w]
```
All files (recursively) will be shuffled and played back. Public log will be displayed to stdout, private to stderr.
### Clients
[monoclient](./monoclient) is a recommended CLI client for lonelyradio that uses [monolib](./monolib)
```shell
monoclient <SERVER>:<PORT>
```
### Other clients
SwiftUI client is availible in [platform](./platform) directory.
[monolib](./monolib) provides lonelyradio-compatible C API for creating custom clients.
## License
lonelyradio, monolib and monoclient are licensed under the terms of the [MIT license](./LICENSE).