feat: initialize Kurdistan SDK - independent fork of Polkadot SDK
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
# The PezkuwiChain Teyrchain Host Implementers' Guide
|
||||
|
||||
The implementers' guide is compiled from several source files with [`mdBook`](https://github.com/rust-lang/mdBook).
|
||||
|
||||
## Hosted build
|
||||
|
||||
This is available [here](https://docs.pezkuwichain.io/sdk/book/).
|
||||
|
||||
## Local build
|
||||
|
||||
To view it locally, run the following (from the `pezkuwi/` directory):
|
||||
|
||||
Ensure graphviz is installed:
|
||||
|
||||
```sh
|
||||
brew install graphviz # for macOS
|
||||
sudo apt-get install graphviz # for Ubuntu/Debian
|
||||
```
|
||||
|
||||
Then install and build the book:
|
||||
|
||||
```sh
|
||||
cargo install mdbook mdbook-linkcheck mdbook-graphviz mdbook-mermaid mdbook-last-changed --locked
|
||||
mdbook serve roadmap/implementers-guide
|
||||
```
|
||||
|
||||
and in a second terminal window run:
|
||||
|
||||
```sh
|
||||
open http://localhost:3000
|
||||
```
|
||||
|
||||
## Specification
|
||||
|
||||
See also the PezkuwiChain specification [hosted](https://spec.polkadot.network/), and its [source](https://github.com/w3f/polkadot-spec).
|
||||
Reference in New Issue
Block a user