From 37ffc811be2514a0b6670afe8a7842d51381ce76 Mon Sep 17 00:00:00 2001 From: Dustin Brickwood Date: Wed, 24 Apr 2024 08:51:35 -0500 Subject: [PATCH 1/2] chore: updates foundry installation --- docs/build/tooling/foundry/getting-started.md | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/build/tooling/foundry/getting-started.md b/docs/build/tooling/foundry/getting-started.md index 4b8783a9fd..4922362ad5 100644 --- a/docs/build/tooling/foundry/getting-started.md +++ b/docs/build/tooling/foundry/getting-started.md @@ -21,13 +21,27 @@ To integrate `foundry-zksync` into your projects, you have the flexibility to in git clone git@github.com:matter-labs/foundry-zksync.git ``` -2. Navigate to the project directory and switch to the main branch: +2. Navigate to the project directory: ```bash - cd foundry-zksync && git checkout dev + cd foundry-zksync ``` -For component-specific installations: +3. Prepare the Installation Script: Ensure the script is executable + +```bash +chmod +x ./install-foundry-zksync +``` + +4. Run the Installer: Execute the script to install the foundry-zksync binaries forge and cast + +```bash +./install-foundry-zksync +``` + +This will install the `forge` and `cast` binaries. You can now begin using `foundry-zksync`! + +For component-specific installations from source: - **Forge**: To install, execute: From 2a51e8a10f24db9be377efcd0ea0224856198741 Mon Sep 17 00:00:00 2001 From: Dustin Brickwood Date: Wed, 24 Apr 2024 12:33:51 -0500 Subject: [PATCH 2/2] chore: update based on feedback --- docs/build/tooling/foundry/getting-started.md | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/build/tooling/foundry/getting-started.md b/docs/build/tooling/foundry/getting-started.md index 4922362ad5..833c413591 100644 --- a/docs/build/tooling/foundry/getting-started.md +++ b/docs/build/tooling/foundry/getting-started.md @@ -17,15 +17,15 @@ To integrate `foundry-zksync` into your projects, you have the flexibility to in 1. Clone the repository: - ```bash - git clone git@github.com:matter-labs/foundry-zksync.git - ``` +```bash +git clone git@github.com:matter-labs/foundry-zksync.git +``` 2. Navigate to the project directory: - ```bash - cd foundry-zksync - ``` +```bash +cd foundry-zksync +``` 3. Prepare the Installation Script: Ensure the script is executable @@ -39,29 +39,29 @@ chmod +x ./install-foundry-zksync ./install-foundry-zksync ``` -This will install the `forge` and `cast` binaries. You can now begin using `foundry-zksync`! +Once the `forge` and `cast` binaries are installed, you can start using `foundry-zksync`. Source your preferred profile or refresh your terminal window to activate the changes. You are now ready to begin working with `foundry-zksync`! For component-specific installations from source: - **Forge**: To install, execute: - ```bash - cargo install --path ./crates/forge --profile local --force --locked - ``` +```bash +cargo install --path ./crates/forge --profile local --force --locked +``` - **Cast**: To install, run: - ```bash - cargo install --path ./crates/cast --profile local --force --locked - ``` +```bash +cargo install --path ./crates/cast --profile local --force --locked +``` For the entire suite: - Execute the following command for a comprehensive installation: - ```bash - cargo build --release - ``` +```bash +cargo build --release +``` Choose the installation that best fits your development needs.