setup.md

Development Setup

Requirements: Rust 1.85+ (stable). Install via rustup.

Clone and build

git clone https://github.com/ashlar-display/culvert.git
cd culvert
cargo build

Running checks

cargo fmt --check
cargo clippy --all-features -- -D warnings
cargo rustdoc --all-features -- -D missing_docs

Running tests

cargo test                      # default features
cargo test --features plumbob   # with the plumbob::ScdcClient impl and end-to-end tests

Measuring coverage

Coverage requires cargo-llvm-cov:

cargo install cargo-llvm-cov
cargo llvm-cov

The current baseline is stored in .coverage-baseline. CI fails if coverage drops more than 0.1% below it. On pushes to main or develop, an improvement automatically opens a ci/coverage-ratchet PR to commit the new baseline.

Running the example

cargo run --example scdc