pptx-reporter/docs/development/README.md

949 B

Development

PPTX Reporter is a Rust workspace with one application crate. The crate exposes the shared reporting core plus pptx-reporter and pptx-reporter-gui binaries.

Install a current Rust toolchain and run from the repository root:

cargo fmt --all --check
cargo clippy --locked --workspace --all-targets --all-features -- -D warnings
cargo test --locked --workspace --all-features
RUSTDOCFLAGS="-D warnings" cargo doc --locked --workspace --all-features --no-deps
python3 -m unittest discover -s tests -v

cargo build --locked -p pptx-reporter --no-default-features builds the CLI without desktop or PDF features. Ordinary builds include both. FFprobe is a runtime dependency for reading media metadata; packaging scripts download only checksum-pinned builds and keep them outside Git.

See CI and coverage and cross builds and releases for the automated validation and portable packaging workflows.