mirror of
https://github.com/storytold/photocraft.git
synced 2026-11-14 14:12:44 +00:00
1fe689a7bf
* docs: add mdBook and security documentation foundation * docs: point book links at storytold/photocraft; scope the credits entry The book's repository/edit URLs and source links pointed at the contributor's fork. The credits entry now describes what this PR contributed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Brandon Thomas <echelon@gmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
934 B
934 B
Building
PhotoCraft uses the Rust workspace at the repository root. Install the stable Rust toolchain, clone the repository, and run commands from that root.
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.