From 7b23e40fad68f6373d627b3ae7f36840b9f26180 Mon Sep 17 00:00:00 2001 From: Ian Suvak Date: Wed, 17 Jul 2024 10:19:01 -0400 Subject: [PATCH 1/2] Update README.md to point developers to install ava-labs fork of foundry --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 168bcac7a..095b98956 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,12 @@ The Teleporter protocol, on the other hand, is implemented at the smart contract To get started with using Teleporter, see [How to Deploy Teleporter Enabled Subnets on a Local Network](https://docs.avax.network/tooling/cli-cross-chain/teleporter-on-local-networks) -- [Deployed Addresses](#deployed-addresses-for-latest-major-version) +- [Deployed Addresses](#deployed-addresses) - [A Note on Versioning](#a-note-on-versioning) - [Setup](#setup) - [Initialize the repository](#initialize-the-repository) - [Dependencies](#dependencies) - [Structure](#structure) -- [Run a local testnet in Docker](#run-a-local-testnet-in-docker) - - [Start up the local testnet](#start-up-the-local-testnet) - - [Additional notes](#additional-notes) - [E2E tests](#e2e-tests) - [Run specific E2E tests](#run-specific-e2e-tests) - [Run the E2E tests on another network](#run-the-e2e-tests-on-another-network) @@ -55,10 +52,10 @@ Release versions follow the [semver](https://semver.org/) convention of incompat ### Dependencies -- [Ginkgo](https://onsi.github.io/ginkgo/#installing-ginkgo) for running the end-to-end tests -- Docker and Docker Compose v2 for running the local test network +- [Ginkgo](https://onsi.github.io/ginkgo/#installing-ginkgo) for running the end-to-end tests. +- Docker and Docker Compose v2 for running the local test network. - The docker image installs the following: - - [Foundry](https://book.getfoundry.sh/getting-started/installation) + - [Foundry](https://book.getfoundry.sh/) Use `/scripts/install_foundry.sh` to install the ava-labs fork. - [Python3](https://www.python.org/downloads/) ## Structure From 6d7163c4cef7932a234326947bbf325cbd26ec22 Mon Sep 17 00:00:00 2001 From: Ian Suvak Date: Wed, 17 Jul 2024 10:41:56 -0400 Subject: [PATCH 2/2] Update README.md Co-authored-by: cam-schultz <78878559+cam-schultz@users.noreply.github.com> Signed-off-by: Ian Suvak --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 095b98956..8f0716202 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ Release versions follow the [semver](https://semver.org/) convention of incompat - [Ginkgo](https://onsi.github.io/ginkgo/#installing-ginkgo) for running the end-to-end tests. - Docker and Docker Compose v2 for running the local test network. - The docker image installs the following: - - [Foundry](https://book.getfoundry.sh/) Use `/scripts/install_foundry.sh` to install the ava-labs fork. + - [Foundry](https://book.getfoundry.sh/) Use `/scripts/install_foundry.sh` to install the Ava Labs [fork](https://github.com/ava-labs/foundry). - [Python3](https://www.python.org/downloads/) ## Structure