From 6e953989e2cbe5f6f19540b8099574faf07ebd1b Mon Sep 17 00:00:00 2001 From: youssefea Date: Thu, 11 Jan 2024 23:40:44 +0000 Subject: [PATCH] update readme --- .../money-streaming-intro-foundry/README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/projects/money-streaming-intro/money-streaming-intro-foundry/README.md b/projects/money-streaming-intro/money-streaming-intro-foundry/README.md index f0c0847..4a4bd85 100644 --- a/projects/money-streaming-intro/money-streaming-intro-foundry/README.md +++ b/projects/money-streaming-intro/money-streaming-intro-foundry/README.md @@ -2,12 +2,18 @@ ### A basic example to get you started with the Superfluid Constant Flow Agreement -This example has a Youtube walkthrough to go along with it! You can watch it here: https://www.youtube.com/watch?v=1mwbYQ429IU. Note that this tutorial only walks through the contract, not the Foundry test suite or package setup. +This example has a Youtube walkthrough to go along with it! You can watch it here: [https://www.youtube.com/watch?v=1mwbYQ429IU](https://www.youtube.com/watch?v=1mwbYQ429IU). Note that this tutorial only walks through the contract, not the Foundry test suite or package setup. -If you'd like to see a breakdown of the test file for this example, you can find a Youtube tutorial on this here: https://www.youtube.com/watch?v=C_PGd8CPdfg&t=1s. +If you'd like to see a breakdown of the test file for this example, you can find a Youtube tutorial on this here: [https://www.youtube.com/watch?v=C_PGd8CPdfg&t=1s](https://www.youtube.com/watch?v=C_PGd8CPdfg&t=1s). -1. Run `forge install` to install -2. `forge build` to compile contracts -3. `forge test` to run the test suite. +**Important Update**: This README reflects an updated version of the project. The Youtube tutorials linked above are based on an older version of this project. -Note: you might see an issue related to git when running forge install. If you see this error, try adding the `--no-commit` flag +To get started with the updated version: + +1. Install dependencies with specific commands: + + * `forge install superfluid-protocol-monorepo=https://github.com/superfluid-finance/protocol-monorepo@dev --no-commit` + * `forge install https://github.com/OpenZeppelin/openzeppelin-contracts@v4.9.3 --no-commit` +2. Compile the contracts with `forge build`. + +3. Run the test suite with `forge test`.