difftreelog
readme update on generating your own node-template (#16)
in: master
Added readme for generating your own substrate node template
1 file changed
README.mddiffbeforeafterboth242425## Run25## Run262627### Single node development chain27### Single Node Development Chain282829Purge any existing developer chain state:29Purge any existing developer chain state:3030404041Detailed 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`.424243### Multi-node local testnet43### Multi-Node Local Testnet444445If 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.464674```74```757576Additional 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`.7778### Advanced: Generate Your Own Substrate Node Template7980A substrate node template is always based on a certain version of Substrate. You can inspect it by81opening [Cargo.toml](Cargo.toml) and see the template referred to a specific Substrate commit(82`rev` field), branch, or version.8384You can generate your own Substrate node-template based on a particular Substrate85version/commit by running following commands:8687```bash88# git clone from the main Substrate repo89git clone https://github.com/paritytech/substrate.git90cd substrate9192# Switch to a particular branch or commit of the Substrate repo your node-template based on93git checkout <branch/tag/sha1>9495# 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 path97# from the current dir. to output the compressed node template.98.maintain/node-template-release.sh ../node-template.tar.gz99```100101Noted though you will likely get faster and more thorough support if you stick with the releases102provided in this repository.77103