Commit 0f710a19 authored by Chevdor's avatar Chevdor Committed by Gav Wood
Browse files

WIP: Asciidoc (#407)

* Rename readme

* Add some Asciidoc demo

* Remove extra lines
parent ca103aea
= Polkadot API
placeholder
//TODO Write content :)
= Polkadot CLI
== Summary
[source, toml]
----
include::Cargo.toml[lines=2..5]
----
include::doc/shell-completion.adoc[]
== Shell completion
The Polkadot cli command supports shell auto-completion. For this to work, you will need to run the completion script matching you build and system.
Assuming you built a release version using `cargo build --release` and use `bash` run the following:
[source, shell]
source target/release/completion-scripts/polkadot.bash
You can find completion scripts for:
- bash
- fish
- zsh
- elvish
- powershell
To make this change persistent, you can proceed as follow:
.First install
[source, shell]
----
COMPL_DIR=$HOME/.completion
mkdir -p $COMPL_DIR
cp -f target/release/completion-scripts/polkadot.bash $COMPL_DIR/
echo "source $COMPL_DIR/polkadot.bash" >> $HOME/.bash_profile
source $HOME/.bash_profile
----
.Update
When you build a new version of Polkadot, the following will ensure you auto-completion script matches the current binary:
[source, shell]
----
COMPL_DIR=$HOME/.completion
mkdir -p $COMPL_DIR
cp -f target/release/completion-scripts/polkadot.bash $COMPL_DIR/
source $HOME/.bash_profile
----
= Polkadot Collator
placeholder
//TODO Write content :)
= Polkadot Consensus
placeholder
//TODO Write content :)
= Polkadot Executor
placeholder
//TODO Write content :)
= Polkadot Network
placeholder
//TODO Write content :)
= Polkadot Parachain
placeholder
//TODO Write content :)
= Polkadot primitives
placeholder
//TODO Write content :)
= Polkadot Runtime
placeholder
//TODO Write content :)
= Polkadot Service
placeholder
//TODO Write content :)
= Polkadot Src
placeholder
//TODO Write content :)
= Polkadot Statement table
placeholder
//TODO Write content :)
= Polkadot Transactin pool
placeholder
//TODO Write content :)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment