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

Building from Source

Prerequisites

ToolVersion
Rust1.85+ (edition 2024)
Linux onlylibasound2-dev, libudev-dev, libwayland-dev, libxkbcommon-dev

Development Build

git clone <repo-url> nightingale
cd nightingale
cargo build --release

Local Release

Linux / macOS

scripts/make-release.sh

Builds the release binary and packages it into nightingale-<target>.tar.gz.

Windows (PowerShell)

powershell -ExecutionPolicy Bypass -File scripts/make-release.ps1

Builds the release binary and packages it into nightingale-x86_64-pc-windows-msvc.zip.

CLI Flags

FlagDescription
--setupForce re-run of the first-launch bootstrap