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

Open
wants to merge 39 commits into
base: master
Choose a base branch
from
Open

chore: update README for 1.0 #9540

wants to merge 39 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

  • Updates benchmarks (build (against Hardhat) and test (against Foundry from 1 year ago)) and updated charts
  • 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
Merged
@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 Outdated
| 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

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated with the charts, supporting both light and dark mode

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

@zerosnacks zerosnacks force-pushed the zerosnacks/chore-update-readme branch from 4fcfa1e to 854bb21 Compare January 3, 2025 14:24
@zerosnacks zerosnacks requested a review from DaniPopes January 16, 2025 15:41
@zerosnacks zerosnacks marked this pull request as ready for review January 16, 2025 15:41
@zerosnacks zerosnacks self-assigned this Jan 16, 2025
@zerosnacks zerosnacks added A-docs Area: docs T-chore Type: chore labels Jan 16, 2025
grandizzy
grandizzy reviewed Jan 16, 2025
View reviewed changes
Copy link
Collaborator

@grandizzy grandizzy left a comment

Choose a reason for hiding this comment

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

Looks good, left couple of comments re outdated todos / features

crates/forge/README.md Outdated Show resolved Hide resolved
crates/forge/README.md Outdated Show resolved Hide resolved
DaniPopes
DaniPopes reviewed Jan 16, 2025
View reviewed changes
.github/banner.png Outdated Show resolved Hide resolved
DaniPopes
DaniPopes reviewed Jan 17, 2025
View reviewed changes
.github/demo.gif Outdated Show resolved Hide resolved
grandizzy
grandizzy approved these changes Jan 20, 2025
View reviewed changes
Copy link
Collaborator

@grandizzy grandizzy left a comment

Choose a reason for hiding this comment

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

lgtm

DaniPopes
DaniPopes reviewed Jan 20, 2025
View reviewed changes
crates/fmt/README.md Outdated Show resolved Hide resolved
@zerosnacks zerosnacks requested a review from DaniPopes January 20, 2025 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grandizzy grandizzy grandizzy approved these changes

@klkvr klkvr Awaiting requested review from klkvr klkvr is a code owner

@mattsse mattsse Awaiting requested review from mattsse mattsse is a code owner

@yash-atreya yash-atreya Awaiting requested review from yash-atreya yash-atreya is a code owner

@DaniPopes DaniPopes Awaiting requested review from DaniPopes DaniPopes is a code owner

Assignees

@zerosnacks zerosnacks

Labels
A-docs Area: docs T-chore Type: chore
Projects
Foundry
Status: Ready For Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update README for 1.0 release
3 participants
@zerosnacks @grandizzy @DaniPopes