Skip to content

Commit

Permalink
Update README.md (#10)
Browse files Browse the repository at this point in the history
* Update README.md

devnet up

* minor readme updates

* missing suave-geth link

* building instructions

* cleanup

* link to suave-geth devnet instructions
  • Loading branch information
metachris authored Nov 17, 2023
1 parent 1e19da7 commit 6f0a80c
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# SUAVE Suapp Examples

This repository contains several [examples and useful references](/examples/) for building Suapps!

---

See also:

- **https://github.com/flashbots/suave-geth**
Expand All @@ -10,17 +14,21 @@ Writings:
- https://writings.flashbots.net/the-future-of-mev-is-suave
- https://writings.flashbots.net/mevm-suave-centauri-and-beyond

---

## Getting Started

```bash
# Clone this repository
$ git clone https://github.com/flashbots/suapp-examples.git
$ git clone git@github.com:flashbots/suapp-examples.git

# Checkout the suave-geth submodule
$ git submodule init
$ git submodule update
```

---

## Compile the examples

Install [Foundry](https://getfoundry.sh/):
Expand All @@ -35,6 +43,14 @@ Compile:
$ forge build
```

---

## Start the local devnet

See the instructions here: https://github.com/flashbots/suave-geth#starting-a-local-devnet

---

## Run the examples

Check out the [`/examples/`](/examples/) folder for several example Suapps and `main.go` files to deploy and run them!
Expand Down

0 comments on commit 6f0a80c

Please sign in to comment.