diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 9d752a2f4..ea1985072 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -3,7 +3,7 @@ - [Introduction](./intro.md) - [Become a Validator](./validator.md) - [Installation](./install.md) -- [CLI](./cli.md) +- [Command-line Options](./cli.md) - [Advanced Usage for Developers](./advanced.md) - [FAQs](./faq.md) - [Contribute](./contribute.md) diff --git a/docs/src/advanced.md b/docs/src/advanced.md index 7fcd378d2..e82849dc8 100644 --- a/docs/src/advanced.md +++ b/docs/src/advanced.md @@ -36,9 +36,8 @@ mingw32-make test # run the test suite After cloning the repo: ```bash -make # The first `make` invocation will update all Git submodules and prompt you to run `make` again. - # It's only required once per Git clone. You'll run `make update` after each `git pull`, in the future, - # to keep those submodules up to date. +# Build beacon_node and all the tools, using 4 parallel Make jobs +make -j4 # Run tests make test diff --git a/docs/src/cli.md b/docs/src/cli.md index dafe2fdc9..bf6977471 100644 --- a/docs/src/cli.md +++ b/docs/src/cli.md @@ -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 -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: -## CLI Help Message +## Usage ``` $ ./build/beacon_node --help