fix: README update on docker usage (#43)
* use docker to setup a local dev chain. * install docker link * update command * Update README.md Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com> * more commands to start or check a node. * purge chain in docker * update README Co-authored-by: Kaichao Sun <kaichaosuna@gmail.com> Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>main
parent
1b8588241b
commit
3323afae5a
17
README.md
17
README.md
|
@ -82,27 +82,24 @@ Additional CLI usage options are available and may be shown by running `cargo ru
|
||||||
|
|
||||||
### Run in Docker
|
### Run in Docker
|
||||||
|
|
||||||
Install [Docker](https://docs.docker.com/get-docker/) first, then run the following command to start a single node development chain. This command will firstly comipile your code, then start a local dev netork.
|
First, install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).
|
||||||
|
|
||||||
|
Then run the following command to start a single node development chain.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./scripts/docker_run.sh
|
./scripts/docker_run.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
If you just want to run the compiled binary,
|
This command will firstly compile your code, and then start a local development network. You can also replace the default command (`cargo build --release && ./target/release/node-template --dev --ws-external`) by appending your own. A few useful ones are as follow.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Run Substrate node without re-compiling
|
||||||
./scripts/docker_run.sh ./target/release/node-template --dev --ws-external
|
./scripts/docker_run.sh ./target/release/node-template --dev --ws-external
|
||||||
```
|
|
||||||
|
|
||||||
Other commands are similar. Let's try purge the local dev chain here:
|
# Purge the local dev chain
|
||||||
|
|
||||||
```bash
|
|
||||||
./scripts/docker_run.sh ./target/release/node-template purge-chain --dev
|
./scripts/docker_run.sh ./target/release/node-template purge-chain --dev
|
||||||
```
|
|
||||||
|
|
||||||
You can also check whether the code is able to compile or not,
|
# Check whether the code is compilable
|
||||||
|
|
||||||
```bash
|
|
||||||
./scripts/docker_run.sh cargo check
|
./scripts/docker_run.sh cargo check
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue