From 54f4fba13e299a2b6c1d468b40b3598ce6c94f27 Mon Sep 17 00:00:00 2001 From: House of Vanity Date: Fri, 17 Apr 2020 18:38:20 +0300 Subject: [PATCH] Update README.md --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index af803d0..69b7187 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,44 @@ MusFuse is a FUSE filesystem over HTTP for music. It is using [playongo](https:/ - Using cache. - Leverages Rust correctness. +## Dependencies + +FUSE must be installed to build or run programs that use fuse-rs (i.e. kernel driver and libraries. Some platforms may also require userland utils like `fusermount`). A default installation of FUSE is usually sufficient. + +To build fuse-rs or any program that depends on it, `pkg-config` needs to be installed as well. + +### Linux + +[FUSE for Linux][libfuse] is available in most Linux distributions and usually called `fuse`. + +Install on Arch Linux: + +```sh +sudo pacman -S fuse +``` + +Install on Debian based system: + +```sh +sudo apt-get install fuse +``` + +Install on CentOS: + +```sh +sudo yum install fuse +``` + +To build, FUSE libraries and headers are required. The package is usually called `libfuse-dev` or `fuse-devel`. Also `pkg-config` is required for locating libraries and headers. + +```sh +sudo apt-get install libfuse-dev pkg-config +``` + +```sh +sudo yum install fuse-devel pkgconfig +``` + # How to use ```sh @@ -19,4 +57,4 @@ MusFuse is a FUSE filesystem over HTTP for music. It is using [playongo](https:/ $ cargo build --release # And run $ ./target/release/musfuse -``` \ No newline at end of file +```