Repository navigation
docs: add complete project and crate run guides - #23
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Roadrunner had no root or crate READMEs, leaving setup and executable workflows scattered across phase documentation. Add a project guide and a README for each of the five crates, with commands grounded in the merged Phase 17 implementation.
The guides cover toolchain setup, all current CLI commands, OSM extraction/compilation/verification, static and time-dependent traffic, single-order and pooled simulation, dispatch comparison and examples, tests, API docs, all six Criterion targets, replay and benchmark collectors. Crate guides describe public interfaces and module boundaries. Examples specify repository-root invocation, source OSM endpoints, exact source identities required by traffic fixtures, and fresh snapshot output directories.
Document optional Docker/Python OSM prerequisites, versioned scenario semantics, and deferred functionality. Explain that the historical Phase 7 assembler embeds old metadata and align the rider collector's compiler metadata with its benchmark toolchain. This PR changes documentation only; Phase 18 remains deferred.
Validation:
cargo fmt --all -- --check, strict workspace Clippy, and all 159 workspace tests with Rust 1.99.0 for Clippy/tests.osmiumfixture generation were not executed; their command signatures and prerequisites were checked.