lostecho/ncspot
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: add cargo installation method

Browse Source 
Since people were having problems when installing from crates.io, it
would be nice to document it to prevent further problems.
This commit is contained in:
Thomas Frans
2023-06-06 23:43:25 +02:00
committed by Henrik Friedrichsen
parent 3587aa1441
commit 21c26abaa3
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/users.md
View File

@@ -41,6 +41,18 @@ If so, simply install using your distribution's package manager - it
is by far the easiest way. If not, you can build from source instead.
See [Compiling](/doc/developers.md).
### From [crates.io](https://crates.io/crates/ncspot)
`ncspot` can be installed with `cargo`. The `cargo` documentation recommends against installing
software with it. If another option is available from the ones above, it should be preferred. If no
recent version is available for your OS, you can use the following command to install `ncspot` from
[crates.io](https://crates.io/crates/ncspot).
```zsh
# The --locked option is important and the compilation process might fail without it
cargo install --locked ncspot
```
## Key Bindings
The keybindings listed below are configured by default. Additionally, if you
built `ncspot` with MPRIS support, you may be able to use media keys to control