GitCorner

Code

ossartcraftphotocraft🌐
856f865cf98d
building.mdRendered Markdown

Building

PhotoCraft uses the Rust workspace at the repository root. Install the stable Rust toolchain, clone the repository, and run commands from that root.

On Linux, install the windowing, GL and GTK development packages first. The development guide's Prerequisites list them for Debian/Ubuntu, Fedora, Arch and openSUSE.

cargo build --workspace
cargo run --release -p photocraft -- image.psd
cargo run -p photocraft-cli -- --help

The standard repository gates are:

cargo fmt --all -- --check
cargo test --workspace
cargo clippy --workspace --all-targets -- -D warnings
cargo xtask layers
cargo xtask wasm

cargo xtask wasm requires the wasm32-unknown-unknown target. UI work should also be checked using the offscreen snapshot example described in the development guide.

Build the documentation

Install mdBook, then build from the repository root:

cargo install mdbook --locked
mdbook build book

The generated site is written to book/output/ and is not source documentation.