From 8d663970fde293fc56ce129024662952bddb4864 Mon Sep 17 00:00:00 2001 From: wadealexc Date: Mon, 6 May 2024 17:40:09 +0000 Subject: [PATCH] docs: organize readme --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1b5328efb3..e67af6931c 100644 --- a/README.md +++ b/README.md @@ -20,19 +20,6 @@ The main branches we use are: ## Documentation -### Setup - -To set up this repo for the first time, run: - -```bash -make deps -``` - -This will: -* Install the pre-commit hook -* Install foundry and its tools -* Install abigen - ### Basics To get a basic understanding of EigenLayer, check out [You Could've Invented EigenLayer](https://www.blog.eigenlayer.xyz/ycie/). Note that some of the document's content describes features that do not exist yet (like the Slasher). To understand more about how restakers and operators interact with EigenLayer, check out these guides: @@ -54,10 +41,21 @@ foundryup forge build forge test +``` -make bindings +### Contributor Setup + +To set up this repo for the first time, run: + +```bash +make deps ``` +This will: +* Install the pre-commit hook +* Install foundry and its tools +* Install abigen + ### Running Fork Tests We have a few fork tests against ETH mainnet. Passing these requires the environment variable `RPC_MAINNET` to be set. See `.env.example` for an example. Once you've set up your environment, `forge test` should show these fork tests passing.