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

Draft
wants to merge 23 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
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/banner.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 modified .github/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
354 changes: 289 additions & 65 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 @@ -22,7 +22,7 @@ const VERSION_MESSAGE: &str = concat!(
")"
);

/// 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 @@ -19,7 +19,7 @@ use std::{fs, io::Write, path::Path, str::FromStr};
// 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 @@ -30,7 +30,6 @@ vergen = { workspace = true, default-features = false, features = [
[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 @@ -45,7 +44,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
16 changes: 5 additions & 11 deletions crates/chisel/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,23 +1,17 @@
#![doc = include_str!("../README.md")]
//! Chisel is a fast, utilitarian, and verbose Solidity REPL.

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

#[macro_use]
extern crate foundry_common;

pub mod dispatcher;

pub mod cmd;

pub mod dispatcher;
pub mod executor;
pub mod history;

pub mod runner;
pub mod session;

pub mod session_source;

pub mod runner;

pub mod executor;

pub mod solidity_helper;

pub mod prelude {
Expand Down
Loading
Loading