Skip to content

Commit caaca26

Browse files
committed
docs: enhance contributors documentation in readme
1 parent c4e7919 commit caaca26

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,28 @@ make build
155155

156156
The binary will be generated under the folder `target/dist`.
157157

158+
### Run a local network
159+
160+
To initialize a local network configuration, invoke the goal `chain-init` of the `Makefile`:
161+
162+
```sh
163+
make chain-init
164+
```
165+
166+
The node home directory will be generated under the folder `target/deployment/localnet`. The configuration contains a single validator node.
167+
168+
To start the network, invoke the goal `chain-start` of the `Makefile`:
169+
170+
```sh
171+
make chain-start
172+
```
173+
174+
A wallet is preconfigured with some tokens, you can use it as follows:
175+
176+
```sh
177+
axoned --home target/deployment/localnet tx bank send validator [to_address] [amount]
178+
```
179+
158180
## Bug reports & feature requests
159181

160182
If you notice anything not behaving how you expected, if you would like to make a suggestion or would like

0 commit comments

Comments
 (0)