[pedrozaz]

Summary

Makes the experimental vrp-gpu crate and repository easier to use and fork by documenting the implemented CVRP model, public API behavior, numerical contracts, validation requirements, and PTX regeneration workflow. No Rust source, kernel, PTX, or package metadata changes.

Key Changes

1. Crate users

   • Extends the crate README with tested CPU and compile-checked GPU examples, feature and runtime requirements, error and panic behavior, and the limits of the current GPU API.
   • Adds an input and algorithm guide covering Solomon parsing, public-instance invariants, capacity and fleet checks, CPU 2-opt semantics, tie rules, and operations not yet implemented.

2. Forks and contributors

   • Adds a validation matrix distinguishing portable CI from hardware-only evidence, including correctness and performance-report rules.
   • Adds a kernel guide for the pinned nightly/cuda-oxide workspace, PTX ABI review, artifact regeneration, byte-for-byte comparison, and hardware validation.
   • Updates architecture and contribution guidance to describe package boundaries, resource costs, and review expectations.

Commit Included

• docs(project): define user and contributor contracts

Verification

• just ci: format, all-feature check, strict Clippy, 43 regular library tests, two README doctests, rustdoc, package verification, and cargo-deny; seven hardware-only tests remained ignored in portable CI.
• README doctests compiled with both all features and no default features.
• Local Markdown links resolved and git diff --check passed.
• Commit has a valid GPG signature and Signed-off-by trailer.

Scope

The documented CUDA hardware claim is limited to the existing RTX 5060 Ti (sm_120) validation. This PR makes no new performance or cross-device compatibility claim. Its changed files do not overlap the parallel CPU/GPU validation PR.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.