Skip to content

Commit 7190e71

Browse files
authored
Merge pull request #623 from kemuru/master
docs: improve readme "getting started" section
2 parents a87edbd + 9f227ae commit 7190e71

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

web/README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1-
# @kleros/kleros-v2-web
1+
## Contributing
22

3-
🚧 ⚖️ 🚧
3+
### Pre-Requisites
4+
5+
If you haven't already, you need to follow all the previous steps of the **Contributing** section of the repo's [README](https://github.com/kleros/kleros-v2/blob/master/README.md#contributing)
6+
7+
### Getting Started
8+
9+
#### Compile the contracts
10+
11+
```bash
12+
# first you need to go to the kleros-v2/contracts folder, and then compile them
13+
$ cd kleros-v2/contracts
14+
$ yarn build
15+
```
16+
17+
#### Start the frontend
18+
19+
```bash
20+
# first you need to be in the kleros-v2/web folder, and then start it
21+
$ cd kleros-v2/web
22+
$ yarn start
23+
```

0 commit comments

Comments
 (0)