Skip to content

Building from Source

Patrice LECUYER edited this page Jul 31, 2026 · 2 revisions

Building from Source

Prerequisites

  • Rust 1.85+ — install from https://rustup.rs. (The project uses the 2024 edition, so a recent toolchain is required.)

  • Linux only: system development libraries. The quickest way is the helper script, which detects your distribution (Debian/Ubuntu, Fedora, Arch):

    ./packaging/linux/build-deps.sh          # add -y for non-interactive

    Or manually on Debian/Ubuntu:

    sudo apt install libgtk-3-dev libxcb-render0-dev libxcb-shape0-dev \
      libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev libssl-dev libx11-dev
    

Compile

git clone https://github.com/plplecuyer/ximod-architect.git
cd ximod-architect

cargo build --release      # optimized build
cargo run --release        # build and run

The executable is target/release/ximod-architect (.exe on Windows). Make sure the assets/ folder is next to it at runtime.

Application icons

Place your icons in assets/icons/ before building: ximod-architect.ico (Windows, embedded at compile time via build.rs), ximod-architect.icns (macOS), ximod-architect.svg (Linux), ximod-architect.png (runtime icon).

Packaging

  • Windows installer: packaging/windows/ximod-architect.iss (Inno Setup 6).
  • macOS bundle: packaging/macos/create-bundle.sh (universal .app, optional .dmg, signing/notarization).
  • Linux: packaging/linux/install.sh.

Automated builds (CI)

The GitHub Actions workflow .github/workflows/release.yml builds Linux, Windows and macOS binaries — and the Windows setup.exe — automatically on every vX.Y.Z tag, and attaches them to a GitHub Release. Push a tag to trigger it:

git tag -a v1.0.0 -m "XIMOD Architect 1.0.0"
git push origin v1.0.0

Clone this wiki locally