Skip to content

Commit e2217a3

Browse files
raymondkfcheungalvicsam
authored andcommitted
Improve README files (#9760)
This PR makes it easier for first-time builders to just copy-and-paste and fix typos. Relates to paritytech/polkadot-sdk-minimal-template#25
1 parent 48f94de commit e2217a3

File tree

3 files changed

+23
-7
lines changed

3 files changed

+23
-7
lines changed

templates/minimal/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,5 +145,5 @@ the Polkadot SDK documentation resources.
145145

146146
- 👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
147147
[Substrate StackExchange](https://substrate.stackexchange.com/).
148-
- 👥You can also reach out on the [Official Polkdot discord server](https://polkadot-discord.w3f.tools/)
148+
- 👥You can also reach out on the [Official Polkadot discord server](https://polkadot-discord.w3f.tools/)
149149
- 🧑Reach out on [Telegram](https://t.me/substratedevs) for more questions and discussions

templates/parachain/README.docify.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,11 @@ be used to run the parachain template's runtime. `polkadot-omni-node` binary cra
8787

8888
#### Install `polkadot-omni-node`
8989

90-
Please see the installation section at [`crates.io/omni-node`](https://crates.io/crates/polkadot-omni-node).
90+
```sh
91+
cargo install polkadot-omni-node
92+
```
93+
94+
> For more advanced options, please see the installation section at [`crates.io/omni-node`](https://crates.io/crates/polkadot-omni-node).
9195
9296
#### Build `parachain-template-runtime`
9397

@@ -97,7 +101,11 @@ cargo build --profile production
97101

98102
#### Install `staging-chain-spec-builder`
99103

100-
Please see the installation section at [`crates.io/staging-chain-spec-builder`](https://crates.io/crates/staging-chain-spec-builder).
104+
```sh
105+
cargo install staging-chain-spec-builder
106+
```
107+
108+
> For more advanced options, please see the installation section at [`crates.io/staging-chain-spec-builder`](https://crates.io/crates/staging-chain-spec-builder).
101109
102110
#### Use `chain-spec-builder` to generate the `chain_spec.json` file
103111

@@ -256,5 +264,5 @@ relay chain network (see [Parachain Template node](#parachain-template-node) set
256264

257265
- 👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
258266
[Substrate StackExchange](https://substrate.stackexchange.com/).
259-
- 👥You can also reach out on the [Official Polkdot discord server](https://polkadot-discord.w3f.tools/)
267+
- 👥You can also reach out on the [Official Polkadot discord server](https://polkadot-discord.w3f.tools/)
260268
- 🧑Reach out on [Telegram](https://t.me/substratedevs) for more questions and discussions

templates/parachain/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,11 @@ be used to run the parachain template's runtime. `polkadot-omni-node` binary cra
8989

9090
#### Install `polkadot-omni-node`
9191

92-
Please see the installation section at [`crates.io/omni-node`](https://crates.io/crates/polkadot-omni-node).
92+
```sh
93+
cargo install polkadot-omni-node
94+
```
95+
96+
> For more advanced options, please see the installation section at [`crates.io/omni-node`](https://crates.io/crates/polkadot-omni-node).
9397
9498
#### Build `parachain-template-runtime`
9599

@@ -99,7 +103,11 @@ cargo build --profile production
99103

100104
#### Install `staging-chain-spec-builder`
101105

102-
Please see the installation section at [`crates.io/staging-chain-spec-builder`](https://crates.io/crates/staging-chain-spec-builder).
106+
```sh
107+
cargo install staging-chain-spec-builder
108+
```
109+
110+
> For more advanced options, please see the installation section at [`crates.io/staging-chain-spec-builder`](https://crates.io/crates/staging-chain-spec-builder).
103111
104112
#### Use `chain-spec-builder` to generate the `chain_spec.json` file
105113

@@ -258,5 +266,5 @@ relay chain network (see [Parachain Template node](#parachain-template-node) set
258266

259267
- 👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
260268
[Substrate StackExchange](https://substrate.stackexchange.com/).
261-
- 👥You can also reach out on the [Official Polkdot discord server](https://polkadot-discord.w3f.tools/)
269+
- 👥You can also reach out on the [Official Polkadot discord server](https://polkadot-discord.w3f.tools/)
262270
- 🧑Reach out on [Telegram](https://t.me/substratedevs) for more questions and discussions

0 commit comments

Comments
 (0)