WIP: Asciidoc (#407)

* Rename readme * Add some Asciidoc demo * Remove extra lines
2026-06-14 00:31:07 +00:00 · 2018-07-24 11:12:53 +02:00
parent b0714c4c23
commit bb97684112
16 changed files with 175 additions and 63 deletions
@@ -0,0 +1,106 @@
+= Polkadot
+:Author: Polkadot developers
+:Revision: 0.2.0
+:toc:
+:sectnums:
+
+Implementation of a https://polkadot.network node in Rust.
+
+== To play
+
+If you'd like to play with Polkadot, you'll need to install a client like this
+one. First, get Rust (1.26.1 or later) and the support software if you don't already have it:
+
+[source, shell]
+----
+curl https://sh.rustup.rs -sSf | sh
+sudo apt install make clang pkg-config libssl-dev
+----
+
+Then, install Polkadot PoC-2:
+
+[source, shell]
+cargo install --git https://github.com/paritytech/polkadot.git --branch v0.2 polkadot
+
+You'll now have a `polkadot` binary installed to your `PATH`. You can drop the
+`--branch v0.2` or run `cargo install --git https://github.com/paritytech/polkadot.git polkadot`
+to get the very latest version of Polkadot, but these instructions might not work in that case.
+
+=== Krumme Lanke Testnet
+
+You will connect to the global Krumme Lanke testnet by default. To do this, just use:
+
+[source, shell]
+polkadot
+
+If you want to do anything on it (not that there's much to do), then you'll need
+to get some Krumme Lanke DOTs. Ask in the Polkadot watercooler.
+
+=== Development
+
+You can run a simple single-node development "network" on your machine by
+running in a terminal:
+
+[source, shell]
+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.
+
+== 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:
+
+[source, shell]
+polkadot --chain=local --validator --key Alice -d /tmp/alice
+
+and in the other, run:
+
+[source, shell]
+polkadot --chain=local --validator --key 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.
+
+== Hacking on Polkadot
+
+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:
+
+[source, shell]
+----
+curl https://sh.rustup.rs -sSf | sh
+rustup update nightly
+rustup target add wasm32-unknown-unknown --toolchain nightly
+rustup update stable
+cargo install --git https://github.com/alexcrichton/wasm-gc
+sudo apt install cmake pkg-config libssl-dev
+----
+
+Then, grab the Polkadot source code:
+
+[source, shell]
+----
+git clone https://github.com/paritytech/polkadot.git
+cd polkadot
+----
+
+Then build the code:
+
+[source, shell]
+----
+./build.sh  # Builds the WebAssembly binaries
+cargo build # Builds all native code
+----
+
+You can run the tests if you like:
+
+[source, shell]
+cargo test --all
+
+You can start a development chain with:
+
+[source, shell]
+cargo run -- --dev
+
+include::doc/packages.adoc[]