Skip to content
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

Cosmetics changes to the readme. #681

Closed
wants to merge 13 commits into from
Closed

Conversation

AbdelStark
Copy link

@AbdelStark AbdelStark commented Jun 27, 2024

Changes summary

  • Add logo in the readme header
  • Add a header section with badges (CI tests, coverage, license)
  • Refactor readme, reframe, add elements
  • Add benchmarks section with instructions on how to run benchmarks and find visual reports that are published by the CI
  • Add contributors section and use all-contributors

This change is Reviewable

Copy link
Contributor

@alonh5 alonh5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @AbdelStark)


README.md line 47 at r1 (raw file):

## 📊 Benchmarks

Benchmarks can be run using `cargo bench`.

We added a script to run a single-threaded poseidon2 hash proof benchmark, it's called poseidon_benchmark.sh (there''s a mistake in the current README). Could you please add that here as well?

@shaharsamocha7
Copy link
Collaborator

Merged from another branch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants