mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-30 18:41:03 +00:00
WIP: Asciidoc (#407)
* Rename readme * Add some Asciidoc demo * Remove extra lines
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot API
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,11 @@
|
||||
|
||||
= Polkadot CLI
|
||||
|
||||
== Summary
|
||||
|
||||
[source, toml]
|
||||
----
|
||||
include::Cargo.toml[lines=2..5]
|
||||
----
|
||||
|
||||
include::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
|
||||
----
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Collator
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Consensus
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Executor
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Network
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Parachain
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot primitives
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Runtime
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Service
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Src
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Statement table
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
@@ -0,0 +1,5 @@
|
||||
|
||||
= Polkadot Transactin pool
|
||||
|
||||
placeholder
|
||||
//TODO Write content :)
|
||||
Reference in New Issue
Block a user