From 3473fceaea50661dc45f2a0c0e4f84142c3323f8 Mon Sep 17 00:00:00 2001 From: Thomas Frans Date: Tue, 6 Jun 2023 23:43:25 +0200 Subject: [PATCH] docs: add `cargo` installation method Since people were having problems when installing from crates.io, it would be nice to document it to prevent further problems. --- doc/users.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/users.md b/doc/users.md index 5adf54a68..a4ff5113d 100644 --- a/doc/users.md +++ b/doc/users.md @@ -42,6 +42,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