diff --git a/polkadot/api/README.adoc b/polkadot/api/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..8f382d4f439198de1629393d56194dd5a4f4d897 --- /dev/null +++ b/polkadot/api/README.adoc @@ -0,0 +1,5 @@ + += Polkadot API + +placeholder +//TODO Write content :) diff --git a/polkadot/cli/README.adoc b/polkadot/cli/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..54fa5f3f32f776453cd703d0ca2fc219fd9a5f61 --- /dev/null +++ b/polkadot/cli/README.adoc @@ -0,0 +1,11 @@ + += Polkadot CLI + +== Summary + +[source, toml] +---- +include::Cargo.toml[lines=2..5] +---- + +include::doc/shell-completion.adoc[] diff --git a/polkadot/cli/doc/shell-completion.adoc b/polkadot/cli/doc/shell-completion.adoc new file mode 100644 index 0000000000000000000000000000000000000000..2486bed09e7952b55535c7e3e91259399c3e921f --- /dev/null +++ b/polkadot/cli/doc/shell-completion.adoc @@ -0,0 +1,41 @@ + +== 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 +---- diff --git a/polkadot/collator/README.adoc b/polkadot/collator/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..3a5408b489e023a493f13f3a4225990a8ad83472 --- /dev/null +++ b/polkadot/collator/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Collator + +placeholder +//TODO Write content :) diff --git a/polkadot/consensus/README.adoc b/polkadot/consensus/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..a3ac5f631c38cf80064ac01bb1ba144fe4cb9fa7 --- /dev/null +++ b/polkadot/consensus/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Consensus + +placeholder +//TODO Write content :) diff --git a/polkadot/executor/README.adoc b/polkadot/executor/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..1c91cccab5fac34d91e16992c8db023004ee30f9 --- /dev/null +++ b/polkadot/executor/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Executor + +placeholder +//TODO Write content :) diff --git a/polkadot/network/README.adoc b/polkadot/network/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..1c2ad29b1b0981f6c4807f7420c2ffc82d3d34ce --- /dev/null +++ b/polkadot/network/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Network + +placeholder +//TODO Write content :) diff --git a/polkadot/parachain/README.adoc b/polkadot/parachain/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..fbce59a188f42e2357e9056bb6854de15a79d2d0 --- /dev/null +++ b/polkadot/parachain/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Parachain + +placeholder +//TODO Write content :) diff --git a/polkadot/primitives/README.adoc b/polkadot/primitives/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..a8468a0cd96121a34face47d966f6b29b4260ac9 --- /dev/null +++ b/polkadot/primitives/README.adoc @@ -0,0 +1,5 @@ + += Polkadot primitives + +placeholder +//TODO Write content :) diff --git a/polkadot/runtime/README.adoc b/polkadot/runtime/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..86dc313134a086dee98de0c34a096485102744cd --- /dev/null +++ b/polkadot/runtime/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Runtime + +placeholder +//TODO Write content :) diff --git a/polkadot/service/README.adoc b/polkadot/service/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..3de386712855d0335c90b8c3409fa4fa927f5a9d --- /dev/null +++ b/polkadot/service/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Service + +placeholder +//TODO Write content :) diff --git a/polkadot/src/README.adoc b/polkadot/src/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..fed228df0b6bd3c5a47992412c0b0cd445e25ee6 --- /dev/null +++ b/polkadot/src/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Src + +placeholder +//TODO Write content :) diff --git a/polkadot/statement-table/README.adoc b/polkadot/statement-table/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..402f55108f4e95fd72ca6da025e22b542a4a48c2 --- /dev/null +++ b/polkadot/statement-table/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Statement table + +placeholder +//TODO Write content :) diff --git a/polkadot/transaction-pool/README.adoc b/polkadot/transaction-pool/README.adoc new file mode 100644 index 0000000000000000000000000000000000000000..868a3434b3e9e3a580599d4f7cce3e1ca730da30 --- /dev/null +++ b/polkadot/transaction-pool/README.adoc @@ -0,0 +1,5 @@ + += Polkadot Transactin pool + +placeholder +//TODO Write content :)