Skip to content

Commit 6554b8a

Browse files
DrW3RKJay Pan
authored andcommitted
Update Templates README docs (paritytech#4980)
Some of the commands needed update for seamless "newbie" Polkadot SDK templates experience
1 parent 8edf78e commit 6554b8a

4 files changed

Lines changed: 15 additions & 15 deletions

File tree

templates/minimal/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* 🤏 This template is a minimal (in terms of complexity and the number of components)
1515
template for building a blockchain node.
1616

17-
* 🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets
17+
* 🔧 Its runtime is configured with a single custom pallet as a starting point, and a handful of ready-made pallets
1818
such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
1919

2020
* 👤 The template has no consensus configured - it is best for experimenting with a single node network.
@@ -57,7 +57,7 @@ and don't forget to also customize the corresponding comments.
5757
🔨 Use the following command to build the node without launching it:
5858

5959
```sh
60-
cargo build --release
60+
cargo build --package minimal-template-node --release
6161
```
6262

6363
🐳 Alternatively, build the docker image:
@@ -80,7 +80,7 @@ docker run --rm polkadot-sdk-minimal-template --dev
8080
Development chains:
8181

8282
* 🧹 Do not persist the state.
83-
* 💰 Are preconfigured with a genesis state that includes several prefunded development accounts.
83+
* 💰 Are preconfigured with a genesis state that includes several pre-funded development accounts.
8484
* 🧑‍⚖️ Development accounts are used as `sudo` accounts.
8585

8686
### Connect with the Polkadot-JS Apps Front-End

templates/parachain/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* ☁️ It is based on the
1717
[Cumulus](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/cumulus/index.html) framework.
1818

19-
* 🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets
19+
* 🔧 Its runtime is configured with a single custom pallet as a starting point, and a handful of ready-made pallets
2020
such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
2121

2222
* 👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains)
@@ -44,7 +44,7 @@ packages required to compile this template - please take note of the Rust compil
4444
🔨 Use the following command to build the node without launching it:
4545

4646
```sh
47-
cargo build --release
47+
cargo build --package parachain-template-node --release
4848
```
4949

5050
🐳 Alternatively, build the docker image:
@@ -70,7 +70,7 @@ and `zombienet` - into `PATH` like so:
7070
export PATH="./target/release/:$PATH"
7171
```
7272

73-
This way, we can conveniently use them un the following steps.
73+
This way, we can conveniently use them in the following steps.
7474

7575
👥 The following command starts a local development chain, with a single relay chain node and a single parachain collator:
7676

templates/parachain/node/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
⚙️ It acts as a remote procedure call (RPC) server, allowing interaction with the blockchain.
99

10-
👉 Learn more about the architecture, and a difference between a node and a runtime
10+
👉 Learn more about the architecture, and the difference between a node and a runtime
1111
[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/wasm_meta_protocol/index.html).
1212

1313
👇 Here are the most important files in this node template:

templates/solochain/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ installation](#alternatives-installations) options.
2828
Use the following command to build the node without launching it:
2929

3030
```sh
31-
cargo build --release
31+
cargo build --package solochain-template-node --release
3232
```
3333

3434
### Embedded Docs
@@ -37,7 +37,7 @@ After you build the project, you can use the following command to explore its
3737
parameters and subcommands:
3838

3939
```sh
40-
./target/release/node-template -h
40+
./target/release/solochain-template-node -h
4141
```
4242

4343
You can generate and view the [Rust
@@ -54,19 +54,19 @@ The following command starts a single-node development chain that doesn't
5454
persist state:
5555

5656
```sh
57-
./target/release/node-template --dev
57+
./target/release/solochain-template-node --dev
5858
```
5959

6060
To purge the development chain's state, run the following command:
6161

6262
```sh
63-
./target/release/node-template purge-chain --dev
63+
./target/release/solochain-template-node purge-chain --dev
6464
```
6565

6666
To start the development chain with detailed logging, run the following command:
6767

6868
```sh
69-
RUST_BACKTRACE=1 ./target/release/node-template -ldebug --dev
69+
RUST_BACKTRACE=1 ./target/release/solochain-template-node -ldebug --dev
7070
```
7171

7272
Development chains:
@@ -75,7 +75,7 @@ Development chains:
7575
- Use the **Alice** and **Bob** accounts as default validator authorities.
7676
- Use the **Alice** account as the default `sudo` account.
7777
- Are preconfigured with a genesis state (`/node/src/chain_spec.rs`) that
78-
includes several prefunded development accounts.
78+
includes several pre-funded development accounts.
7979

8080

8181
To persist chain state between runs, specify a base path by running a command
@@ -86,7 +86,7 @@ similar to the following:
8686
$ mkdir my-chain-state
8787

8888
// Use of that folder to store the chain state
89-
$ ./target/release/node-template --dev --base-path ./my-chain-state/
89+
$ ./target/release/solochain-template-node --dev --base-path ./my-chain-state/
9090

9191
// Check the folder structure created inside the base path after running the chain
9292
$ ls ./my-chain-state
@@ -142,7 +142,7 @@ following:
142142
file that defines a Substrate chain's initial (genesis) state. Chain
143143
specifications are useful for development and testing, and critical when
144144
architecting the launch of a production chain. Take note of the
145-
`development_config` and `testnet_genesis` functions,. These functions are
145+
`development_config` and `testnet_genesis` functions. These functions are
146146
used to define the genesis state for the local development chain
147147
configuration. These functions identify some [well-known
148148
accounts](https://docs.substrate.io/reference/command-line-tools/subkey/) and

0 commit comments

Comments
 (0)