Open
Conversation
Replaces the flat demo-instructions README with a structured, technical document following the same conventions as the main branch overhaul. - Add quick links row (Getting Started, Examples, Contributing, Issues) - Add Mermaid architecture diagram and crate table - Add end-to-end Example section using noir-examples/basic-4 — all four commands verified locally with nargo v1.0.0-beta.11 - Structured Getting Started as collapsible steps - Profiling section as a table with Tool / Measures / Command columns - Acknowledgements section explaining what each dependency contributes - Fix generate-gnark-inputs to use prover.pkp (correct for v1 CLI) - Fix skyscraper description: M31/CM31 -> BN254
Remove filler intro from Acknowledgements, break the uniform capitalisation pattern in dependency bullets, add explicit nargo version pin, and replace the ### Circuit inspection heading with a contextual prose line.
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.
Summary
Replaces the flat demo-instructions README on the
v1branch with a structured, professional document using the same conventions applied tomainin #420.## Examplesection usingnoir-examples/basic-4— all four commands (nargo compile→prepare→prove→verify) verified locally with nargov1.0.0-beta.11assets/on this branch)v1-specific correctness fixes included:
generate-gnark-inputsuses./prover.pkp(v1 CLI takes the prover key, not verifier key)v1.0.0-beta.11--compiler mavrosoption (not present in v1 CLI)Test plan
nargo compileonnoir-examples/basic-4— clean withv1.0.0-beta.11prepare→prove→verifypipeline — exit code 0