1
1
mirror of https://github.com/mgree/ffs.git synced 2024-08-17 15:20:43 +03:00
ffs/INSTALL.md
Michael Greenberg 7357d88353 Add INSTALL.md to document installation procedures.
Per #31. Thanks for the suggestion, @cipy!

[ci skip]
2021-07-02 10:08:54 -04:00

1.2 KiB

ffs depends on FUSE, and is currently tested on Linux and macOS.

Installing FUSE

On Linux, run sudo apt-get install fuse to install FUSE.

On macOS, run brew install macfuse to install macFUSE.

Installing ffs

The easiest way to install ffs is to grab a release binary. There are two classes of release: numbered releases and latest. Numbered releases are arbitrary stable milestones; latest releases are automatically generated builds from main.

You might also want to get the manpage and install it in an appropriate place.

Source installations

You can also install it from source. ffs is written in Rust, so you'll need to have a Rust compiler to hand. You'll need to make sure you have pkg-config installed; on Linux, you will also need libfuse-dev.

You then have two options: you can run cargo install ffs to get the last numbered release, or you can build entirely locally to use the latest build:

$ git clone https://github.com/mgree/ffs
$ cargo install --path .