Skip to content

Commit 0dccd2f

Browse files
committed
doc: update
1 parent f8a4b7d commit 0dccd2f

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
33
This repository contains the data structures that can be used for the Morpho's matching engine 🦋.
44
The goal is to compare them in terms of security and gas consumption to find the best solution for the protocol and its users.
55

6-
## Installation
7-
8-
Install foundry, you can find the instructions [here](https://book.getfoundry.sh/getting-started/installation.html).
9-
10-
Then, run `make`.
11-
12-
## Testing
13-
14-
Run `make test`.
15-
16-
For the `RedBlackBinaryTree`, you can run the tests with hardhat with `yarn test`.
17-
186
# Data structures
197

208
The data structures we implement and modified are based on public works of amazing developers. We thank them for what they have done 🙏
@@ -51,6 +39,26 @@ Other data structures may be explored in the future and we are open to any sugge
5139

5240
In this section, you will find some guidelines to read before contributing to the project.
5341

42+
## Setup
43+
44+
Update git submodules:
45+
46+
```
47+
git submodule update --init --recursive
48+
```
49+
50+
Run yarn:
51+
52+
```
53+
yarn
54+
```
55+
56+
## Testing
57+
58+
The tests can be run with [foundry](https://github.com/foundry-rs/foundry).
59+
60+
For the `RedBlackBinaryTree`, you can run the tests with hardhat with `yarn test`.
61+
5462
## Creating issues and PRs
5563

5664
Guidelines for creating issues and PRs:

0 commit comments

Comments
 (0)