Skip to content
This repository was archived by the owner on Aug 27, 2024. It is now read-only.

Commit 3323afa

Browse files
Jimmy Chukaichaosunjoepetrowski
authored
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>
1 parent 1b85882 commit 3323afa

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -82,27 +82,24 @@ Additional CLI usage options are available and may be shown by running `cargo ru
8282

8383
### Run in Docker
8484

85-
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.
85+
First, install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).
86+
87+
Then run the following command to start a single node development chain.
8688

8789
```bash
8890
./scripts/docker_run.sh
8991
```
9092

91-
If you just want to run the compiled binary,
93+
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.
9294

9395
```bash
96+
# Run Substrate node without re-compiling
9497
./scripts/docker_run.sh ./target/release/node-template --dev --ws-external
95-
```
9698

97-
Other commands are similar. Let's try purge the local dev chain here:
98-
99-
```bash
99+
# Purge the local dev chain
100100
./scripts/docker_run.sh ./target/release/node-template purge-chain --dev
101-
```
102-
103-
You can also check whether the code is able to compile or not,
104101

105-
```bash
102+
# Check whether the code is compilable
106103
./scripts/docker_run.sh cargo check
107104
```
108105

0 commit comments

Comments
 (0)