Skip to content

Commit efff1f0

Browse files
author
James
committed
Update README.md
1 parent a95bf0d commit efff1f0

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

Diff for: README.md

+24
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,30 @@
22

33
This is a javascript library to interact with commitground platform.
44

5+
# Contributing
6+
7+
## Prerequisites
8+
9+
1. Load submodules
10+
11+
```.bash
12+
git submodule update --init --recursive
13+
```
14+
15+
1. Install truffle
16+
17+
```.bash
18+
npm install -g truffle
19+
```
20+
You can read truffle install doc [here](https://truffleframework.com/docs/getting_started/installation)
21+
22+
1. Ganache(One click ethereum private net).
23+
24+
Two options exist. When you run this repository on your local environment, desktop app will help you know what's happening on the blockchain. But for the CI/CD environment, 'ganache-cli' will be a better option.
25+
- [ganache-cli](https://github.com/trufflesuite/ganache-cli)
26+
- [ganache desktop app](https://truffleframework.com/ganache)
27+
28+
529
# Contributors
630
[Wanseob Lim](https://github.com/james-lim)
731

0 commit comments

Comments
 (0)