mention release installation + update CI badge branch
This commit is contained in:
21
README.md
21
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
[](https://crates.io/crates/ncspot)
|
||||
[](https://gitter.im/ncspot/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||||
[](https://travis-ci.com/hrkfdn/ncspot)
|
||||
[](https://travis-ci.com/hrkfdn/ncspot)
|
||||
|
||||
ncurses Spotify client written in Rust using librespot. It is heavily inspired
|
||||
by ncurses MPD clients, such as ncmpc. My motivation was to provide a simple
|
||||
@@ -35,9 +35,19 @@ sudo apt install libpulse-dev libssl-dev libxcb1-dev libxcb-render0-dev libxcb-s
|
||||
|
||||
## Usage
|
||||
|
||||
* Install the latest release using `cargo install ncspot`
|
||||
* Build using `cargo build --release`
|
||||
* For debugging, pass a debug log filename, e.g. `ncspot -d debug.log`
|
||||
|
||||
## Audio backends
|
||||
|
||||
By default ncspot is built using the Rodio backend. To make it use the
|
||||
PortAudio backend (e.g. for *BSD or macOS), you need to recompile ncspot with
|
||||
the `portaudio_backend` feature:
|
||||
|
||||
* `cargo run --no-default-features --features
|
||||
portaudio_backend,cursive/pancurses-backend`
|
||||
|
||||
### Key Bindings
|
||||
|
||||
These keybindings are hardcoded for now. In the future it may be desirable to
|
||||
@@ -115,12 +125,3 @@ cmdline_bg = "black"
|
||||
|
||||
More examples can be found in pull request
|
||||
https://github.com/hrkfdn/ncspot/pull/40.
|
||||
|
||||
## Audio backends
|
||||
|
||||
By default ncspot is built using the Rodio backend. To make it use the
|
||||
PortAudio backend (e.g. *BSD), you need to recompile ncspot with the
|
||||
`portaudio_backend` feature:
|
||||
|
||||
* `cargo run --no-default-features --features
|
||||
portaudio_backend,cursive/pancurses-backend`
|
||||
|
||||
Reference in New Issue
Block a user