From 2906690893452890adc5845e480904c646be9832 Mon Sep 17 00:00:00 2001
From: joe petrowski <25483142+joepetrowski@users.noreply.github.com>
Date: Tue, 26 May 2020 00:34:04 +0200
Subject: [PATCH] Update README (#1134)
* update readme for current networks
* remove networks docs (they were copy/paste from readme)
* remove trailing whitespace
* add polkadot wiki
* remove hello world name
* remove authors/revision
---
polkadot/README.md | 174 +++++++++++----------------
polkadot/doc/networks/alexander.md | 3 -
polkadot/doc/networks/dev.md | 10 --
polkadot/doc/networks/krummelanke.md | 4 -
polkadot/doc/networks/local.md | 18 ---
polkadot/doc/networks/networks.md | 8 --
6 files changed, 69 insertions(+), 148 deletions(-)
delete mode 100644 polkadot/doc/networks/alexander.md
delete mode 100644 polkadot/doc/networks/dev.md
delete mode 100644 polkadot/doc/networks/krummelanke.md
delete mode 100644 polkadot/doc/networks/local.md
delete mode 100644 polkadot/doc/networks/networks.md
diff --git a/polkadot/README.md b/polkadot/README.md
index efae8ab32ab..496d5933d6c 100644
--- a/polkadot/README.md
+++ b/polkadot/README.md
@@ -1,164 +1,118 @@
----
-author: Polkadot developers
-revision: 0.3.1
----
-
# Polkadot
-Implementation of a https://polkadot.network node in Rust.
-
-## NOTE
-
-In 2018 we split our implementation of "Polkadot" from its platform-level component "Substrate". When we split them, we split the Polkadot code off into another repo (this repo), leaving the [**Substrate** repo][substrate-repo] to be what used to be Polkadot, along with its branches and releases.
-
-We are actively building both Substrate and Polkadot, but things will be a little odd for a while. If you see "substrate" and are wondering why you need it for Polkadot, now you know.
-
-To connect on the "Kusama" canary network, you will want the `v0.7` code, which is in this **Polkadot** repo. To play on the ("Alexander") testnet, you'll want the PoC-4 code instead. Note that PoC-3 uses the Alexander testnet, but will not be able to sync to the latest block.
-
-* **Kusama** (né Kusama CC-3) is in this [**Polkadot**] repo `master` branch.
-
-* **Kusama CC-2** is in this [**Polkadot**][polkadot-v0.6] repo branch `v0.6`.
+Implementation of a https://polkadot.network node in Rust based on the Substrate framework.
-* **Kusama CC-1** is in this [**Polkadot**][polkadot-v0.5] repo branch `v0.5`.
+> **NOTE:** In 2018, we split our implementation of "Polkadot" from its development framework
+> "Substrate". See the [Substrate][substrate-repo] repo for git history prior to 2018.
-* **Polkadot PoC-4 "Alexander"** is in this [**Polkadot**][polkadot-v0.4] repo branch `v0.4`.
+[substrate-repo]: https://github.com/paritytech/substrate
-* **Polkadot PoC-3 "Alexander"** is in this [**Polkadot**][polkadot-v0.3] repo branch `v0.3`.
+This repo contains runtimes for the Polkadot, Kusama, and Westend networks. The README provides
+information about installing the `polkadot` binary and developing on the codebase. For more
+specific guides, like how to be a validator, see the
+[Polkadot Wiki](https://wiki.polkadot.network/docs/en/).
-* **Polkadot PoC-2 "Krumme Lanke"** is in the [**Substrate**][substrate-v0.2] repo branch `v0.2`.
+## Building
-[substrate-repo]: https://github.com/paritytech/substrate
-[polkadot-v0.6]: https://github.com/paritytech/polkadot/tree/v0.6
-[polkadot-v0.5]: https://github.com/paritytech/polkadot/tree/v0.5
-[polkadot-v0.4]: https://github.com/paritytech/polkadot/tree/v0.4
-[polkadot-v0.3]: https://github.com/paritytech/polkadot/tree/v0.3
-[substrate-v0.2]: https://github.com/paritytech/substrate/tree/v0.2
+### Use a Provided Binary
-## To play
+If you want to connect to one of the networks supported by this repo, you can go to the latest
+release and download the binary that is provided.
-### Install Rust
-If you'd like to play with Polkadot, you'll need to install a client like this
-one. First, get Rust (1.39.0 or later) and the support software if you don't already have it:
+### Install via Cargo
+If you want to install Polkadot in your PATH, you can do so with with:
```bash
-curl https://sh.rustup.rs -sSf | sh
+cargo install --force --git https://github.com/paritytech/polkadot --tag <version> polkadot
```
-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:
+### Build from Source
+
+If you'd like to build from source, first install Rust. You may need to add Cargo's bin directory
+to your PATH environment variable. Restarting your computer will do this for you automatically.
```bash
-sudo apt install make clang pkg-config libssl-dev
+curl https://sh.rustup.rs -sSf | sh
```
If you already have Rust installed, make sure you're using the latest version by running:
-
```bash
rustup update
```
-### Install "Kusama CC-3" Canary Network
-
-Build Kusama by cloning this repository and running the following commands from the root directory of the repo:
-
-```bash
-git checkout master
-./scripts/init.sh
-cargo build --release
-```
-
-Connect to the global Kusama canary network by default by running:
+Once done, finish installing the support software:
```bash
-./target/release/polkadot --name "hello world!"
+sudo apt install make clang pkg-config libssl-dev
```
-You can see your node on [telemetry].
-
-[telemetry]: https://telemetry.polkadot.io/#list/Kusama%20CC3
-
-### Install PoC-4 on "Alexander" Testnet
-
-Build Polkadot PoC-4 by cloning this repository and running the following commands from the root directory of the repo:
+Build the client by cloning this repository and running the following commands from the root
+directory of the repo:
```bash
-git checkout v0.4
+git checkout <latest tagged release>
./scripts/init.sh
-./scripts/build.sh
cargo build --release
```
-If you were previously running PoC-3 on this testnet, you may need to purge your chain data first:
-
-```bash
-./target/release/polkadot purge-chain
-```
-
-Finally, connect to the global "Alexander" testnet by default by running:
+## Networks
-```bash
-./target/release/polkadot
-```
+This repo supports runtimes for Polkadot, Kusama, and Westend.
-### Install PoC-2 "Krumme Lanke" Testnet
-
-Install Polkadot PoC-2 and have a `polkadot` binary installed to your `PATH` with:
-
-```
-cargo install --git https://github.com/paritytech/substrate.git --branch v0.2 polkadot
-```
+### Connect to Polkadot Chain Candidate 1 (CC1)
-Connect to the global "Krumme Lanke" testnet by default by running:
+Connect to the global Polkadot CC1 network by running:
```bash
-polkadot
+./target/release/polkadot --chain=polkadot
```
-### Install a custom Testnet version
+You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).
-You can run the following to get the very latest version of Polkadot, but these instructions will not work in that case.
+[telemetry]: https://telemetry.polkadot.io/#list/Polkadot%20CC1
-```bash
-cargo install --git https://github.com/paritytech/polkadot.git polkadot
-```
+### Connect to the "Kusama" Canary Network
-If you want a specific version of Polkadot, say `0.2.5`, you may run
+Connect to the global Kusama canary network by running:
```bash
-cargo install --git https://github.com/paritytech/substrate.git --tag v0.2.5 polkadot
+./target/release/polkadot --chain=kusama
```
-### Obtaining DOTs
+You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).
-If you want to do anything on it (not that there's much to do), then you'll need to get an account and some Alexander or Krumme Lanke DOTs. Ask in the Polkadot watercooler ( https://riot.im/app/#/room/#polkadot-watercooler:matrix.org ) or get some from the Polkadot Testnet Faucet ( https://faucet.polkadot.network/ ).
+[telemetry]: https://telemetry.polkadot.io/#list/Kusama
-### Development
+### Connect to the Westend Testnet
-You can run a simple single-node development "network" on your machine by
-running in a terminal:
+Connect to the global Westend testnet by running:
```bash
-polkadot --dev
+./target/release/polkadot --chain=westend
```
-You can muck around by cloning and building the http://github.com/paritytech/polka-ui and http://github.com/paritytech/polkadot-ui or just heading to https://polkadot.js.org/apps and choose "Alexander (hosted by Parity)" from the Settings menu.
-
+You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).
-## Building
+[telemetry]: https://telemetry.polkadot.io/#list/Westend
-### Hacking on Polkadot
+### Obtaining DOTs
-If you'd actually like hack on Polkadot, you can just grab the source code and build it. Ensure you have Rust and the support software installed:
+If you want to do anything on Polkadot, Kusama, or Westend, then you'll need to get an account and
+some DOT, KSM, or WND tokens, respectively. See the
+[claims instructions](https://claims.polkadot.network/) for Polkadot if you have DOTs to claim. For
+Westend's WND tokens, see the faucet
+[instructions](https://wiki.polkadot.network/docs/en/learn-DOT#getting-westies) on the Wiki.
-```bash
-curl https://sh.rustup.rs -sSf | sh
-```
+## Hacking on Polkadot
-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:
+If you'd actually like hack on Polkadot, you can grab the source code and build it. Ensure you have
+Rust and the support software installed. This script will install or update Rust and install the
+required dependencies (this may take up to 30 minutes on Mac machines):
```bash
-sudo apt install cmake pkg-config libssl-dev git clang
+curl https://getsubstrate.io -sSf | bash -s -- --fast
```
Then, grab the Polkadot source code:
@@ -168,7 +122,8 @@ git clone https://github.com/paritytech/polkadot.git
cd polkadot
```
-Then build the code:
+Then build the code. You will need to build in release mode (`--release`) to start a network. Only
+use debug mode for development (faster compile times for development and testing).
```bash
./scripts/init.sh # Install WebAssembly. Update Rust
@@ -190,12 +145,24 @@ cargo run -- --dev
Detailed logs may be shown by running the node with the following environment variables set:
```bash
-RUST_LOG=debug RUST_BACKTRACE=1 cargo run —- --dev
+RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev
+```
+
+### Development
+
+You can run a simple single-node development "network" on your machine by running:
+
+```bash
+polkadot --dev
```
+You can muck around by heading to https://polkadot.js.org/apps and choose "Local Node" from the
+Settings menu.
+
### Local Two-node Testnet
-If you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet. You'll need two terminals open. In one, run:
+If you want to see the multi-node consensus algorithm in action locally, then you can create a
+local testnet. You'll need two terminals open. In one, run:
```bash
polkadot --chain=polkadot-local --alice -d /tmp/alice
@@ -215,9 +182,6 @@ Ensure you replace `ALICE_BOOTNODE_ID_HERE` with the node ID from the output of
### Shell Completion
[Shell Completion](doc/shell-completion.md)
-### Polkadot Networks
-[Polkadot Networks](doc/networks/networks.md)
-
## Contributing
### Contributing Guidelines
diff --git a/polkadot/doc/networks/alexander.md b/polkadot/doc/networks/alexander.md
deleted file mode 100644
index ede2f20db4a..00000000000
--- a/polkadot/doc/networks/alexander.md
+++ /dev/null
@@ -1,3 +0,0 @@
-### Alexander
-
-Alexander is a testnet network used during the developement of PoC-3.
diff --git a/polkadot/doc/networks/dev.md b/polkadot/doc/networks/dev.md
deleted file mode 100644
index dde7bb19ac3..00000000000
--- a/polkadot/doc/networks/dev.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-### Dev network
-
-You can run a simple single-node development "network" on your machine by running in a terminal:
-
-```bash
-polkadot --dev
-```
-
-You can muck around by cloning and building the http://github.com/paritytech/polka-ui and http://github.com/paritytech/polkadot-ui or just heading to https://polkadot.js.org/apps.
diff --git a/polkadot/doc/networks/krummelanke.md b/polkadot/doc/networks/krummelanke.md
deleted file mode 100644
index 07c56e78502..00000000000
--- a/polkadot/doc/networks/krummelanke.md
+++ /dev/null
@@ -1,4 +0,0 @@
-
-### Krumme Lanke
-
-Krumme Lanke is a testnet network used during the developement of PoC-2.
diff --git a/polkadot/doc/networks/local.md b/polkadot/doc/networks/local.md
deleted file mode 100644
index 6120229f774..00000000000
--- a/polkadot/doc/networks/local.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-### Local Two-node Testnet
-
-If you want to see the multi-node consensus algorithm in action locally, then
-you can create a local testnet. You'll need two terminals open. In one, run:
-
-```bash
-polkadot --chain=poladot-local --alice -d /tmp/alice
-```
-
-and in the other, run:
-
-```bash
-polkadot --chain=polkadot-local --bob -d /tmp/bob --port 30334 --bootnodes '/ip4/127.0.0.1/tcp/30333/p2p/ALICE_BOOTNODE_ID_HERE'
-```
-
-Ensure you replace `ALICE_BOOTNODE_ID_HERE` with the node ID from the output of
-the first terminal.
diff --git a/polkadot/doc/networks/networks.md b/polkadot/doc/networks/networks.md
deleted file mode 100644
index 7ba5b04401d..00000000000
--- a/polkadot/doc/networks/networks.md
+++ /dev/null
@@ -1,8 +0,0 @@
-
-## Polkadot networks
-
-[dev](./dev.md)
-
-[local](./local.md)
-
-[krummelanke](./krummelanke.md)
--
GitLab