Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.54 KB

BUILDING.md

File metadata and controls

37 lines (22 loc) · 1.54 KB

Building

Build Requirements

To build the application from source, a Rust toolchain is required.

  • Use cargo build to compile or cargo run to compile and run the application in debug mode.
  • Use cargo build --release to compile or cargo run --release to compile and run the application in release mode.

Windows Installer (optional)

cargo-wix must be installed to create a Windows installer.

  • Run cargo wix to build the installer (msi).
  • The installer will be created in the target/wix folder.

Mac Application Bundle (optional)

To build a macOS application bundle, additional dependencies must be installed:

Run ./build-mac-bundle.sh from the project directory. Make sure the script has executable permissions.

The bundle will be created in the target/release/bundle/osx folder. If the custom app icon does not show up, copy/paste it manually from the icons folder using the finder info dialog.

Linux AppImage (optional)

To build an AppImage for Linux, additional dependencies must be installed:

Run ./build-linux-appimage.sh from the project directory. Make sure the script has executable permissions. The AppImage will be created in the ./target/release/appimage directory.