status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix comments

This commit is contained in:
李婷婷 2020-06-20 10:37:51 +08:00
parent b3193e0659
commit 1dab3538ff
3 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/SUMMARY.md
View File

@ -3,7 +3,7 @@
- [Introduction](./intro.md) - [Introduction](./intro.md)
- [Become a Validator](./validator.md) - [Become a Validator](./validator.md)
- [Installation](./install.md) - [Installation](./install.md)
- [CLI](./cli.md) - [Command-line Options](./cli.md)
- [Advanced Usage for Developers](./advanced.md) - [Advanced Usage for Developers](./advanced.md)
- [FAQs](./faq.md) - [FAQs](./faq.md)
- [Contribute](./contribute.md) - [Contribute](./contribute.md)

5
docs/src/advanced.md
View File

@ -36,9 +36,8 @@ mingw32-make test # run the test suite
After cloning the repo: After cloning the repo:
```bash ```bash
make # The first `make` invocation will update all Git submodules and prompt you to run `make` again. # Build beacon_node and all the tools, using 4 parallel Make jobs
# It's only required once per Git clone. You'll run `make update` after each `git pull`, in the future, make -j4
# to keep those submodules up to date.
# Run tests # Run tests
make test make test

8
docs/src/cli.md
View File

@ -1,16 +1,16 @@
# CLI # Command-line Options
You can run your customized beacon node using the beacon_node CLI. The available options are shown below. You can run your customized beacon node using the beacon_node executable. The available options are shown below.
## Prerequisites ## Prerequisites
Specifying a genesis file is mandatory to run this CLI. You can either get it from the official eth2 repository [here](https://github.com/eth2-clients/eth2-testnets/blob/master/shared/witti/genesis.ssz) or generate your own like [this](https://github.com/status-im/nim-beacon-chain/blob/db92c2f2549a339be60896c3907cefdb394b5e11/scripts/launch_local_testnet.sh#L154) when starting a local testnet. You can also specify the path of your genesis file like [this](https://github.com/status-im/nim-beacon-chain/blob/db92c2f2549a339be60896c3907cefdb394b5e11/scripts/launch_local_testnet.sh#L229). Specifying a genesis file is mandatory to run this executable. You can either get it from the official eth2 repository [here](https://github.com/eth2-clients/eth2-testnets/blob/master/shared/witti/genesis.ssz) or generate your own like [this](https://github.com/status-im/nim-beacon-chain/blob/db92c2f2549a339be60896c3907cefdb394b5e11/scripts/launch_local_testnet.sh#L154) when starting a local testnet. You can also specify the path of your genesis file like [this](https://github.com/status-im/nim-beacon-chain/blob/db92c2f2549a339be60896c3907cefdb394b5e11/scripts/launch_local_testnet.sh#L229).
For example, download a genesis file and then run the following command to start the node: For example, download a genesis file and then run the following command to start the node:
<img src="./img/beacon_node_example.PNG" alt="" style="margin: 0 40 0 40"/> <img src="./img/beacon_node_example.PNG" alt="" style="margin: 0 40 0 40"/>
## CLI Help Message ## Usage
``` ```
$ ./build/beacon_node --help $ ./build/beacon_node --help