Skip to content

Commit 3a0cc58

Browse files
docs: Adjusted the README.md
1 parent 285a6b0 commit 3a0cc58

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,37 @@
11
# LooksRare Staking
22

3-
This project contains all smart contracts used for staking and other token economics (excluding the airdrop contract).
3+
This project contains all smart contracts used for staking and other token-related contracts (excluding the airdrop contract!).
44

5-
It is a hybrid Hardhat repo that also requires Forge to run Solidity tests powered by the [ds-test library](https://github.com/dapphub/ds-test/).
5+
## NPM package
66

7-
To install Forge, please follow the instructions [here](https://onbjerg.github.io/foundry-book/getting-started/installation.html#using-foundryup).
7+
The NPM package contains the following:
88

9-
## Tests
9+
- Solidity smart contracts (_".sol"_)
10+
- ABI files (_".json"_)
1011

11-
TypeScript tests are included in the `test` folder at the root of this repo.
12+
## About this repo
1213

13-
Solidity tests are included in the `test` folder in the `contracts` folder.
14+
### Structure
1415

15-
## Example of Forge commands
16+
It is a hybrid [Hardhat](https://hardhat.org/) repo that also requires [Forge](https://onbjerg.github.io/foundry-book/index.html) to run Solidity tests powered by the [ds-test library](https://github.com/dapphub/ds-test/).
17+
18+
> To install Forge, please follow the instructions [here](https://onbjerg.github.io/foundry-book/getting-started/installation.html#using-foundryup).
19+
20+
### Run tests
21+
22+
- TypeScript tests are included in the `test` folder at the root of this repo.
23+
- Solidity tests are included in the `test` folder in the `contracts` folder.
24+
25+
### Example of Forge commands
1626

1727
```shell
28+
forge build
1829
forge test
19-
forge test -vvvv
30+
forge test -vv
31+
forge tree
2032
```
2133

22-
## Example of Hardhat commands
34+
### Example of Hardhat commands
2335

2436
```shell
2537
npx hardhat accounts

0 commit comments

Comments
 (0)