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.

Sign up for GitHub

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

Jump to bottom

chore: update README for 1.0 #9540

Draft
wants to merge 23 commits into
base: master
Choose a base branch
from
Draft

chore: update README for 1.0 #9540

wants to merge 23 commits into from

Conversation

zerosnacks
Copy link
Member

@zerosnacks zerosnacks commented Dec 11, 2024 •
edited
Loading

Motivation

Closes: #9419
Related: foundry-rs/book#1371

Solution

Work in progress

  • Updates benchmarks (build (against Hardhat) and test (against Foundry from 1 year ago))
  • Add basic commands for the binaries to get started immediately
  • Applies general updates / clean up
  • Some of the diff is due to automated formatting changes

Rendered README.md

@zerosnacks zerosnacks added the T-blocked Type: blocked label Dec 11, 2024
@zerosnacks zerosnacks mentioned this pull request Dec 12, 2024
Draft
@zerosnacks zerosnacks changed the title chore: update README chore: update README for 1.0 Dec 12, 2024
DaniPopes
DaniPopes reviewed Dec 12, 2024
View reviewed changes
Copy link
Member

@DaniPopes DaniPopes left a comment

Choose a reason for hiding this comment

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

So far LGTM.

re licenses: I don't know what you mean "recognized by GitHub", they already are:
image

LICENSE-APACHE Outdated Show resolved Hide resolved
LICENSE-MIT Outdated Show resolved Hide resolved
docs/dev/README.md Outdated Show resolved Hide resolved
README.md
| Cold | 9.07s | 28.08s | 3.1x |
| Light Cache | 0.99s | 5.11s | 5.2x |
| Deep Cache | 2.29s | 8.66s | 3.8x |
| Full Cache | 0.18s | 0.47s | 2.6x |
Copy link
Member

Choose a reason for hiding this comment

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

perhaps some nice rendered chart PNGs? @gakonst

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@zerosnacks
Copy link
Member Author

zerosnacks commented Dec 13, 2024 •
edited
Loading

re licenses: I don't know what you mean "recognized by GitHub", they already are: image

Hmm.. yesterday these tabs were showing a generic | license | license | here

Screenshot from 2024-12-13 09-10-46

Looks like it does get recognized correctly (Github did have some data issues yesterday), will revert my changes / apply suggestions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DaniPopes DaniPopes DaniPopes left review comments

@klkvr klkvr Awaiting requested review from klkvr klkvr will be requested when the pull request is marked ready for review klkvr is a code owner

@mattsse mattsse Awaiting requested review from mattsse mattsse will be requested when the pull request is marked ready for review mattsse is a code owner

@grandizzy grandizzy Awaiting requested review from grandizzy grandizzy will be requested when the pull request is marked ready for review grandizzy is a code owner

@yash-atreya yash-atreya Awaiting requested review from yash-atreya yash-atreya will be requested when the pull request is marked ready for review yash-atreya is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
T-blocked Type: blocked
Projects
Foundry
Status: No status
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update README for 1.0 release
2 participants
@zerosnacks @DaniPopes