Skip to content
This repository was archived by the owner on May 3, 2024. It is now read-only.

Commit b375282

Browse files
adam-majAdam Majmudar
andauthored
Update README.md and Makefile with setup instructions (#120)
Co-authored-by: Adam Majmudar <adam@Adams-MacBook-Pro.local>
1 parent deef9ee commit b375282

File tree

2 files changed

+4
-20
lines changed

2 files changed

+4
-20
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ clean-env:
77
poetry shell
88

99
init:
10+
# Setup poetry first: https://python-poetry.org/docs/
1011
poetry install
1112
poetry run yarn add hardhat
1213
poetry run pip3 install eth-brownie

README.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -99,32 +99,15 @@ If you want to work with this repository, make sure to setup [Poetry](https://py
9999
Assuming you've installed and setup poetry, you can setup this repository with:
100100

101101
```bash
102-
$ poetry shell
103-
$ poetry install
104-
$ poetry run yarn global add ganache
105-
$ poetry run yarn add hardhat
106-
```
107-
108-
Alternatively, if your system can run .sh files, you can set everything up by running the following bash script:
109-
110-
```bash
111-
$ bash scripts/env/setup.sh
102+
$ make init
112103
```
113104

114105
### Running Tests
115106

116-
Before running tests, make sure you've already run `poetry shell` and are in the poetry virutal environment with all dependencies installed.
117-
118-
Once you have checked that this you have all the dependencies, you can run the following:
107+
Once you have run the initialization step, you can run the following to run all tests:
119108

120109
```bash
121-
$ poetry run brownie test --network hardhat
122-
```
123-
124-
To properly setup testing, you'll also need to add your private key to the `.env` file as follows (do NOT use a private key of one of your actual wallets):
125-
126-
```.env
127-
PRIVATE_KEY=...
110+
$ make test
128111
```
129112

130113
### Code Style Setup

0 commit comments

Comments
 (0)