Did a bit of work on the README

This commit is contained in:
Dave Hrycyszyn
2024-06-18 15:20:46 +01:00
parent fbf547ce0e
commit 8375e4ce1e

View File

@@ -1,25 +1,31 @@
# Side
# Side BFT-CRDT PoC
This is a proof of concept implementation of a BFT-CRDT blockchain system.
## Running in development
Run the watcher first:
```bash
cd side-watcher
cargo watch -x run
```
To init a Side node:
```bash
cd side-node
cargo run -- init node1
cargo run -- init node2
cargo run -- init node3
cargo run -- init node4
```
To start a node with a cargo watch for development purposes (from the side-node dir):
To start a node with a cargo watch for development purposes (from the side-node dir), open up a few terminals and run:
```bash
cargo watch -x "run -- run -- node1"
```
To run the watcher:
```bash
cd side-watcher
cargo watch -x run
cargo watch -x "run -- run -- node2"
cargo watch -x "run -- run -- node3"
cargo watch -x "run -- run -- node4"
```