README.md: change instructions to use release builds.

On embedded devices (which many people use librespot on), debug builds
are too slow and produce choppy audio.
This commit is contained in:
Paul Lietar 2016-02-25 22:30:49 +00:00
parent de357e63c9
commit ace5d09662

View file

@ -26,14 +26,14 @@ brew install portaudio protobuf
Once you've cloned this repository you can build *librespot* using `cargo`. Once you've cloned this repository you can build *librespot* using `cargo`.
```shell ```shell
cargo build cargo build --release
``` ```
## Usage ## Usage
A sample program implementing a headless Spotify Connect receiver is provided. A sample program implementing a headless Spotify Connect receiver is provided.
Once you've built *librespot*, run it using : Once you've built *librespot*, run it using :
```shell ```shell
target/debug/librespot --appkey APPKEY --username USERNAME --cache CACHEDIR --name DEVICENAME target/release/librespot --appkey APPKEY --username USERNAME --cache CACHEDIR --name DEVICENAME
``` ```
## Discovery mode ## Discovery mode
@ -43,7 +43,7 @@ dns-sd or avahi's compatibility layer is required for this. On debian/ubuntu thi
It must be enabled at build time : It must be enabled at build time :
```shell ```shell
cargo build --features discovery cargo build --release --features discovery
``` ```
When running *librespot* simply omit the `--username` argument. When running *librespot* simply omit the `--username` argument.