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+ (workspace uses edition 2024)
Node.js20+
pnpmlatest
Linux onlylibwebkit2gtk-4.1-dev, libssl-dev, libayatana-appindicator3-dev, librsvg2-dev, libxdo-dev, libasound2-dev

Development

git clone <repo-url> nightingale
cd nightingale
cargo desktop dev

This starts the Tauri development server with hot-reload for the React frontend.

Release Build

cargo desktop build

Builds the production app bundle for your current platform using Tauri’s bundler.

Re-running Setup

If something goes wrong with the vendor environment, you can force a fresh setup from the sidebar actions menu inside the app by selecting Re-run Setup.