-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: prepare Readme and documentation for new release #284
Open
seemenkina
wants to merge
7
commits into
master
Choose a base branch
from
docs-update-readme
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
Benchmark for 1e41944Click to view benchmark
|
Benchmark for 7e0fdc6Click to view benchmark
|
Benchmark for 1e41944Click to view benchmark
|
Benchmark for cfd4faaClick to view benchmark
|
Benchmark for 7e0fdc6Click to view benchmark
|
Benchmark for 1e41944Click to view benchmark
|
Benchmark for cfd4faaClick to view benchmark
|
Benchmark for 7e0fdc6Click to view benchmark
|
Benchmark for cfd4faaClick to view benchmark
|
Benchmark for dea53baClick to view benchmark
|
Benchmark for dea53baClick to view benchmark
|
Benchmark for dea53baClick to view benchmark
|
Benchmark for 520795aClick to view benchmark
|
Benchmark for 520795aClick to view benchmark
|
Benchmark for 520795aClick to view benchmark
|
f88c99f
to
00e0281
Compare
Benchmark for af698acClick to view benchmark
|
Benchmark for af698acClick to view benchmark
|
Benchmark for af698acClick to view benchmark
|
00e0281
to
4502790
Compare
Benchmark for 3aa3257Click to view benchmark
|
Benchmark for 3aa3257Click to view benchmark
|
…instructions - Clarify build and test instructions for default features - Update RLN circuit compilation process with new repository path - Add section for compiling zkey to arkzkey format - Update circuit compilation notes with new Circom version and parameters - Remove references to multiple pre-compiled circuits
- Improve README.md for main project and RLN module with more comprehensive documentation - Add badges, overview sections, and detailed usage instructions - Include important notes about platform compatibility and feature support - Expand build, test, and circuit compilation instructions - Update acknowledgements and project structure descriptions - Provide more detailed code examples and protocol flow explanation
- Add detailed overview of Merkle tree and Poseidon hash implementations - Include installation instructions and crate version badge - Provide performance considerations and build/test guidance - Update acknowledgements with source references - Improve markdown formatting and readability
- Reorder and clarify steps for generating zkey, verification key, and witness calculation graph - Add more detailed explanations for each step in the circuit compilation process - Improve formatting and provide context for circuit parameter customization - Enhance readability of instructions for generating RLN circuit resources
4502790
to
4abab8b
Compare
Benchmark for 3aa3257Click to view benchmark
|
Benchmark for ee503c1Click to view benchmark
|
Benchmark for ee503c1Click to view benchmark
|
Benchmark for ee503c1Click to view benchmark
|
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.
Update documentation for rln, utils and zerokit itself