Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Development

Prerequisites (for building from source)

Building requires the FUSE3 development headers to compile the fuser crate:

# Debian / Ubuntu
sudo apt install libfuse3-dev pkg-config

# Fedora
sudo dnf install fuse3-devel

# macOS
brew install macfuse

Pre-commit hooks (prek)

This repo uses prek to run cargo fmt and cargo clippy before each commit.

# Install prek (one time)
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/j178/prek/releases/download/v0.4.11/prek-installer.sh | sh

# Install the git hook (per clone)
prek install

Running tests

cargo test

Building for release

cargo build --release