diff --git a/.gitmodules b/.gitmodules index f6f3beb..5c21a3f 100644 --- a/.gitmodules +++ b/.gitmodules @@ -4,4 +4,3 @@ [submodule "lib/forge-std"] path = lib/forge-std url = https://github.com/foundry-rs/forge-std - branch = v1.7.1 diff --git a/README.md b/README.md index 8ee64a1..991aaef 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ $ git submodule update Install [Foundry](https://getfoundry.sh/): -``` +```bash $ curl -L https://foundry.paradigm.xyz | bash ``` @@ -55,6 +55,20 @@ See the instructions here: https://github.com/flashbots/suave-geth#starting-a-lo Check out the [`/examples/`](/examples/) folder for several example Suapps and `main.go` files to deploy and run them! +## Contributing + +Some notes and helpers for contributing to this repository: + +```bash +# Install testing dependencies +$ go install mvdan.cc/gofumpt@v0.4.0 +$ go install honnef.co/go/tools/cmd/staticcheck@v0.4.5 +$ go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.0 + +# Update the git submodules to the latest commit +$ git submodule update --remote +``` + --- Happy hacking 🛠️