Skip to content

Commit

Permalink
update README.md with the use of scripts/bootstrap.py
Browse files Browse the repository at this point in the history
  • Loading branch information
eugene-babichenko committed May 26, 2021
1 parent f59601e commit d67912c
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,26 +108,20 @@ setup:
```sh
mkdir mynode
cd mynode
PATH/TO/SOURCE/REPOSITORY/scripts/bootstrap <options>
python3 PATH/TO/SOURCE/REPOSITORY/scripts/bootstrap.py <options>
```

Use the following recommended bootstrap options:

```sh
bootstrap -b # BFT setup
bootstrap -g -s 2 # Genesis-praos setup
bootstrap -h # further help
bootstrap --bft # BFT setup
bootstrap --genesis-praos --slot-duration 2 # Genesis-praos setup
bootstrap --help # further help
```

The bootstrap script creates a simple setup with a faucet with 10 millions
coins, a BFT leader, and a stake pool.

It also creates 2 shell scripts parametrized to this specific
run of bootstrap:

* `faucet-send-money`
* `faucet-send-certificate`

Both scripts can be used to do simple limited operation through the jcli
debugging tools.

Expand Down

0 comments on commit d67912c

Please sign in to comment.