From 2a8754815cfc73a51bc2cd6492156ec51910587f Mon Sep 17 00:00:00 2001 From: talwat <83217276+talwat@users.noreply.github.com> Date: Mon, 7 Oct 2024 22:46:10 +0200 Subject: [PATCH] docs: update linux dependencies --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6f2d4e0..38c32e0 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,19 @@ you're interested in downloading the tracks. Beware, there's a lot of them. ## Installing +> ![NOTE] +> If you're interested in maintaining a package for `lowfi` +> on package managers such as homebrew and the like, open an issue. + +### Dependencies + You'll need Rust 1.74.0+. -If you're on linux, you also need the OpenSSL & Alsa headers. -Alsa can be installed with `alsa-lib` on Arch or `libasound2-dev` on Ubuntu. +On MacOS & Windows, no extra dependencies are needed. + +On Linux, you'll also need alsa and it's headers (`alsa-lib` on Arch, +`libasound2-dev` on Ubuntu). Make sure to also install `pulseaudio-alsa` +if you're using pulseaudio. ### Cargo @@ -39,6 +48,9 @@ The recommended installation method is to use cargo: ```sh cargo install lowfi + +# If you want MPRIS support. +cargo install lowfi --features mpris ``` and making sure `$HOME/.cargo/bin` is added to `$PATH`.