git.delta.rocks / unique-network / refs/commits / 1d6e83047429

difftreelog

readme update on generating your own node-template (#16)

Jimmy Chu2020-01-08parent: #9e02251.patch.diff
in: master
Added readme for generating your own substrate node template

1 file changed

modifiedREADME.mddiffbeforeafterboth
2424
25## Run25## Run
2626
27### Single node development chain27### Single Node Development Chain
2828
29Purge any existing developer chain state:29Purge any existing developer chain state:
3030
4040
41Detailed logs may be shown by running the node with the following environment variables set: `RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev`.41Detailed logs may be shown by running the node with the following environment variables set: `RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev`.
4242
43### Multi-node local testnet43### Multi-Node Local Testnet
4444
45If you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet with two validator nodes for Alice and Bob, who are the initial authorities of the genesis chain that have been endowed with testnet units.45If you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet with two validator nodes for Alice and Bob, who are the initial authorities of the genesis chain that have been endowed with testnet units.
4646
74```74```
7575
76Additional CLI usage options are available and may be shown by running `cargo run -- --help`.76Additional CLI usage options are available and may be shown by running `cargo run -- --help`.
77
78### Advanced: Generate Your Own Substrate Node Template
79
80A substrate node template is always based on a certain version of Substrate. You can inspect it by
81opening [Cargo.toml](Cargo.toml) and see the template referred to a specific Substrate commit(
82`rev` field), branch, or version.
83
84You can generate your own Substrate node-template based on a particular Substrate
85version/commit by running following commands:
86
87```bash
88# git clone from the main Substrate repo
89git clone https://github.com/paritytech/substrate.git
90cd substrate
91
92# Switch to a particular branch or commit of the Substrate repo your node-template based on
93git checkout <branch/tag/sha1>
94
95# Run the helper script to generate a node template.
96# This script compiles Substrate and takes a while to complete. It takes a relative file path
97# from the current dir. to output the compressed node template.
98.maintain/node-template-release.sh ../node-template.tar.gz
99```
100
101Noted though you will likely get faster and more thorough support if you stick with the releases
102provided in this repository.
77103