From f61e532e9140abaaa255d4d840602fbc5da0e521 Mon Sep 17 00:00:00 2001 From: Tommy Giardina <37459104+tgiardina@users.noreply.github.com> Date: Fri, 22 Nov 2019 17:27:36 -0600 Subject: [PATCH] Clarifying README (#590) Made two small changes to the README.adoc that will help first-time users. First, I added notifications that the user may need to edit their PATH env variable after installing Rust. Second, I added a 'Hello world!' name tag to the Kusama Canary Network connect command so that new users will be better able to find their node on telemetry. --- polkadot/README.adoc | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/polkadot/README.adoc b/polkadot/README.adoc index 8a2fd2ab03..c7f414707f 100644 --- a/polkadot/README.adoc +++ b/polkadot/README.adoc @@ -32,6 +32,12 @@ one. First, get Rust (1.32.0 or later) and the support software if you don't alr [source, shell] ---- curl https://sh.rustup.rs -sSf | sh +---- + +You may need to add Cargo's bin directoy to your PATH environment variable. Restarting your computer will do this for you automatically. Once done, finish installing the support software: + +[source, shell] +---- sudo apt install make clang pkg-config libssl-dev ---- @@ -56,7 +62,7 @@ cargo build --release Connect to the global Kusama canary network by default by running: ```bash -./target/release/polkadot +./target/release/polkadot --name "hello world!" ``` You can see your node on link:https://telemetry.polkadot.io/#list/Kusama%20CC2[telemetry]. @@ -146,6 +152,12 @@ If you'd actually like hack on Polkadot, you can just grab the source code and b [source, shell] ---- curl https://sh.rustup.rs -sSf | sh +---- + +You may need to add Cargo's bin directoy to your PATH environment variable. Restarting your computer will do this for you automatically. Once done, finish installing the support software: + +[source, shell] +---- sudo apt install cmake pkg-config libssl-dev git clang ----