Skip to content
Snippets Groups Projects

improve documentation

Merged Hugo Trentesaux requested to merge hugo-fix-typo into master
1 file
+ 29
4
Compare changes
  • Side-by-side
  • Inline
+ 29
4
@@ -4,6 +4,31 @@ A rewriting of [Duniter](https://duniter.org) based on [Substrate](https://www.s
duniter-v2s is under active development, only a test network called "ĞDev" is deployed.
## Documentation TOC
- [README.md]
- [Use](#use)
- [Test](#test)
- [Contribute](#contribute)
- [Structure](#project-structure)
- [docs](./docs/)
- [api](./docs/api/)
- [manual](./docs/api/manual.md)
- [runtime-calls](./docs/api/runtime-calls.md)
- [dev](./docs/dev/)
- [git-conventions](./docs/dev/git-conventions.md)
- [launch-a-live-network](./docs/dev/launch-a-live-network.md)
- [setup](./docs/dev/setup.md)
- [verify-runtime-code](./docs/dev/verify-runtime-code.md)
- [weights-benchmarking](./docs/dev/weights-benchmarking.md)
- [test](./docs/test/)
- [replay-block](./docs/test/replay-block.md)
- [user](./docs/user/)
- [autocompletion](./docs/user/autocompletion.md)
- [build-for-arm](./docs/user/build-for-arm.md)
- [rpc](./docs/user/rpc.md)
- [smith](./docs/user/smith.md)
## Use
### Join ĞDev network
@@ -20,8 +45,8 @@ To go further, read [How to deploy a permanent mirror node on ĞDev network](./d
### Create your local blockchain
It can be useful to deploy your local blockchain, for instance to have a controled environement
to develop/test an application that interact with the blockchain.
It can be useful to deploy your local blockchain, for instance to have a controlled environement
to develop/test an application that interacts with the blockchain.
```docker
docker run -it -p9944:9944 duniter/duniter-v2s:v0.1.0 --tmp
@@ -31,9 +56,9 @@ Or use the `docker-compose.yml` at the root of this repository.
#### Control when your local blockchain should produce blocks
By default, your local blockchain produce a new block every 6 seconds, which is not practical in some cases.
By default, your local blockchain produces a new block every 6 seconds, which is not practical in some cases.
You can decide when to produce blocks with the cli option `--sealing`, , there are 2 possible modes:
You can decide when to produce blocks with the cli option `--sealing` which has two modes:
* `--sealing=instant`: produce a block immediately upon receiving a transaction into the transaction pool
* `--sealing=manual`: produce a block upon receiving an RPC request (method `engine_createBlock`).
Loading