docs: finalize README (banner, badges, runnable quickstart)#25
Merged
Conversation
- Add the org banner + the standard badge row (CI/CodeQL/codecov/license/
scorecard/best-practices/provenance/docs), the ecosystem line, and the full
section set (determinism, status, ProofSpec/Proof, canonicalization, verifying
a foreign proof, engine-version pinning, layout, building, requirements,
benchmarks, contributing, security, disclaimer).
- Correct the canonicalization description to the pure {:.8} decimal rounding
(the earlier round_to wording was stale).
- Make the CLI quickstart actually runnable: the CLI's --spec takes a config
file ({ "spec": <ProofSpec> }), which no committed file provided. Add
examples/data/config.json and a matching examples/data/config.proof.json so
`prove` and `verify` copy-paste green.
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
1 participant
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.
Finalizes the top-level
README.md:{:.8}decimal rounding (the oldround_to(_, 1e-8)wording predated the moat fix).--spectakes a config file ({ "spec": <ProofSpec> }), which no committed file provided — the spec fixtures are bareProofSpecs used via the command API. Addsexamples/data/config.jsonand a matchingexamples/data/config.proof.json, both verified locally (proveemits the hash,verifyprintsvalid).Docs + example data only; no code or workflow changes.