Skip to content

Commit

Permalink
verify: Add a README file
Browse files Browse the repository at this point in the history
Add a brief readme file, point at `cargo run -- --help` and also at the
docs we already wrote in `types/README.md`.
  • Loading branch information
tcharding committed Mar 6, 2025
1 parent f5fe7e5 commit 06119ca
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions verify/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Verify

TL;DR: `cargo run -- --help`

This crate provides a tool to help verify the rest of the repository.
Specifically the Single Source Of Truth for a specific Core version is
the version module in `types` e.g., `types/src/v17/mod.rs`.

Verification is warranted because there are many pieces involved and
during development much cut'n'paste. We want to catch our mistakes and
have some confidence that our claims are valid.

Please see `types/README.md` for more information.


0 comments on commit 06119ca

Please sign in to comment.