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.
This commit is contained in:
Tommy Giardina
2019-11-22 17:27:36 -06:00
committed by Gavin Wood
parent c9b1e3d959
commit f61e532e91
+13 -1
View File
@@ -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
----