Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
youssefea committed Jan 11, 2024
1 parent b87e9d9 commit 6e95398
Showing 1 changed file with 12 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected] --no-commit`
2. Compile the contracts with `forge build`.

3. Run the test suite with `forge test`.

0 comments on commit 6e95398

Please sign in to comment.