From 8375e4ce1e0ddc8fe3837d4f4a9631726f5e57c0 Mon Sep 17 00:00:00 2001 From: Dave Hrycyszyn Date: Tue, 18 Jun 2024 15:20:46 +0100 Subject: [PATCH] Did a bit of work on the README --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 62b1b2e..ad3f0c5 100644 --- a/README.md +++ b/README.md @@ -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" ```