Skip to content

Commit 5d655d4

Browse files
committed
Write a simple guide on how to run chains in the README.md file
1 parent 0a661a0 commit 5d655d4

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

ibc.ts/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,20 @@ IBC relayer and scenario
22
=========================
33

44
This directory contains IBC relayer implementation and IBC demo scenario script.
5+
6+
## Before start
7+
8+
1. Please run `yarn install`. It will install dependencies.
9+
2. Please run `cp .env.default .env`
10+
11+
## How to run chains
12+
13+
Run `yarn run runChains`
14+
15+
## Print debug log
16+
17+
Please use `DEBUG` environment variable.
18+
If you want to print all debug log,
19+
please use "\*" for the `DEBUG` environment variable, like: `DEBUG="*"`
20+
21+
For example you can run like this: `DEBUG="*" yarn run runChains`

0 commit comments

Comments
 (0)