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

chore: update README for 1.0 #9540

Merged
merged 41 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
947515f
start adding new benchmarks and recording
zerosnacks Dec 11, 2024
3103340
add benchmarks
zerosnacks Dec 11, 2024
f455419
add solady compilation benchmark
zerosnacks Dec 11, 2024
c8d4c1b
crop demo gif to scale better
zerosnacks Dec 11, 2024
96f72e4
clean up
zerosnacks Dec 11, 2024
b8a6f4d
fix morpho-blue integration test, skewed because of create2 mining
zerosnacks Dec 11, 2024
e2569a7
add compilation comparison for openzeppelin
zerosnacks Dec 12, 2024
c81b3e9
add very basic getting started
zerosnacks Dec 12, 2024
235092e
add basic examples for each tool
zerosnacks Dec 12, 2024
da911f3
clean up
zerosnacks Dec 12, 2024
6b66c1c
clean up
zerosnacks Dec 12, 2024
e51341d
use default MIT and Apache 2.0 licenses for auto-recognition by Github
zerosnacks Dec 12, 2024
defbfbe
apply default format of license, using existing fields
zerosnacks Dec 12, 2024
816ed1f
clean up, point to book as primary source rather than crates
zerosnacks Dec 12, 2024
a1eb204
clean up dev docs
zerosnacks Dec 12, 2024
9fcd813
spell fix
zerosnacks Dec 12, 2024
7e3778b
clean up
zerosnacks Dec 12, 2024
e007b05
nits
zerosnacks Dec 12, 2024
bf37038
nits
zerosnacks Dec 12, 2024
c15322e
revert to previous license version, updated format was not necessary …
zerosnacks Dec 13, 2024
0c54c20
Apply suggestions from code review
zerosnacks Dec 13, 2024
a323206
note dual support
zerosnacks Dec 13, 2024
9fb8bd3
Merge branch 'zerosnacks/chore-update-readme' of github.com:foundry-r…
zerosnacks Dec 13, 2024
854bb21
fix link to actions
zerosnacks Jan 3, 2025
b4a05b8
Merge branch 'master' into zerosnacks/chore-update-readme
zerosnacks Jan 9, 2025
24a1b5d
link directly to existing references rather than overviews
zerosnacks Jan 9, 2025
0ca54b8
Merge branch 'master' into zerosnacks/chore-update-readme
zerosnacks Jan 9, 2025
1f3c627
Merge branch 'master' into zerosnacks/chore-update-readme
zerosnacks Jan 16, 2025
e760919
add designed benchmarks
zerosnacks Jan 16, 2025
e26351e
improve size slightly
zerosnacks Jan 16, 2025
c99f863
use center alignment
zerosnacks Jan 16, 2025
26d8ef4
fix spacing
zerosnacks Jan 16, 2025
7cf0e15
fix spacing
zerosnacks Jan 16, 2025
13ebab3
update image paths
zerosnacks Jan 17, 2025
20c3fd0
remove outdated Foundry docs, users should refer to the book
zerosnacks Jan 17, 2025
300a994
remove outdated docs, Foundry book should serve as primary source unt…
zerosnacks Jan 17, 2025
8638dae
move demo.gif, remove unused logo
zerosnacks Jan 17, 2025
23033e6
fix build
zerosnacks Jan 17, 2025
fedb14a
update table in fmt, restore docs for crate
zerosnacks Jan 20, 2025
90a2bee
fix merge conflict
zerosnacks Jan 28, 2025
fc1f6ef
try fixing rpc that is down
zerosnacks Jan 28, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/assets/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/build_benchmark_solady_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/build_benchmark_solady_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed .github/demo.gif
Binary file not shown.
Binary file removed .github/logo.png
Binary file not shown.
2 changes: 0 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion LICENSE-APACHE
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,4 @@
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
identification within third-party archives.
2 changes: 1 addition & 1 deletion LICENSE-MIT
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
356 changes: 289 additions & 67 deletions README.md

Large diffs are not rendered by default.

103 changes: 0 additions & 103 deletions crates/anvil/README.md

This file was deleted.

3 changes: 2 additions & 1 deletion crates/anvil/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#![doc = include_str!("../README.md")]
//! Anvil is a fast local Ethereum development node.

#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]

use crate::{
Expand Down
5 changes: 0 additions & 5 deletions crates/cast/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion crates/cast/bin/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use foundry_common::{
};
use std::{path::PathBuf, str::FromStr};

/// Perform Ethereum RPC calls from the comfort of your command line.
/// A Swiss Army knife for interacting with Ethereum applications from the command line.
#[derive(Parser)]
#[command(
name = "cast",
Expand Down
3 changes: 2 additions & 1 deletion crates/cast/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#![doc = include_str!("../README.md")]
//! Cast is a Swiss Army knife for interacting with Ethereum applications from the command line.
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]

use alloy_consensus::TxEnvelope;
Expand Down
2 changes: 1 addition & 1 deletion crates/cast/tests/cli/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Build Profile: [..]
// tests `--help` is printed to std out
casttest!(print_help, |_prj, cmd| {
cmd.arg("--help").assert_success().stdout_eq(str![[r#"
Perform Ethereum RPC calls from the comfort of your command line
A Swiss Army knife for interacting with Ethereum applications from the command line

Usage: cast[..] <COMMAND>

Expand Down
3 changes: 0 additions & 3 deletions crates/cheatcodes/spec/README.md

This file was deleted.

3 changes: 2 additions & 1 deletion crates/cheatcodes/spec/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
#![doc = include_str!("../README.md")]
//! Cheatcode specification for Foundry.

#![cfg_attr(not(test), warn(unused_crate_dependencies))]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]

Expand Down
2 changes: 0 additions & 2 deletions crates/chisel/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ path = "bin/main.rs"
[dependencies]
# forge
forge-fmt.workspace = true
foundry-block-explorers.workspace = true
foundry-cli.workspace = true
foundry-common.workspace = true
foundry-compilers = { workspace = true, features = ["project-util", "full"] }
Expand All @@ -38,7 +37,6 @@ alloy-primitives = { workspace = true, features = [
"rlp",
] }
alloy-json-abi.workspace = true
alloy-rpc-types.workspace = true

clap = { version = "4", features = ["derive", "env", "wrap_help"] }
dirs = "5"
Expand Down
Loading
Loading