Skip to content

Commit 3ecf5e8

Browse files
committed
Update README.md
1 parent a947076 commit 3ecf5e8

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,21 @@ For the user interface to work, you need to have the following installed on your
1818
- Node.js
1919
- pnpm
2020

21-
Installing everything on macOS:
21+
Installing everything on macOS using HomeBrew can be done with the following commands:
2222

2323
```
2424
brew install openjdk@17 node pnpm
2525
```
2626

27+
For other operating systems, please refer to the respective installation instructions.
28+
2729
## Building
2830

29-
To build the benchmarking suite, run the following command:
31+
To install dependencies and build the benchmarking suite, run the following commands:
3032

3133
```
3234
./gradlew build
35+
(cd webui && pnpm install)
3336
```
3437

3538
## Running
@@ -45,11 +48,27 @@ To run the benchmarking suite, run the following command:
4548
To run the web interface, run the following command:
4649

4750
```
48-
(cd webui && pnpm install && pnpm run kubb:generate && pnpm run dev)
51+
(cd webui && pnpm run kubb:generate && pnpm run dev)
4952
```
5053

54+
> [!NOTE]
55+
> The simulator must be running for `kubb:generate` to succeed.
56+
5157
The UI should then be available at http://localhost:3000.
5258

59+
## Running Benchmarks
60+
61+
We currently have the following protocols implemented:
62+
63+
- [PBFT](simulator/src/main/java/byzzbench/simulator/protocols/pbft/PbftReplica.java): The original PBFT protocol, as
64+
described in
65+
the [PBFT paper](https://www.microsoft.com/en-us/research/publication/practical-byzantine-fault-tolerance/);
66+
- [PBFT-Java](simulator/src/main/java/byzzbench/simulator/protocols/pbft_java/PbftReplica.java): A buggy version of
67+
PBFT,
68+
from the [PBFT-Java repository](https://github.com/caojohnny/pbft-java);
69+
- [Fast-HotStuff](simulator/src/main/java/byzzbench/simulator/protocols/fasthotstuff/FastHotStuffReplica.java): A
70+
failed attempt at improving HotStuff, as described in the [Fast-HotStuff paper](https://arxiv.org/abs/2010.11454);
71+
5372
## Documentation
5473

5574
- [Implementing new BFT Protocols](docs/implementing-protocols.md)

0 commit comments

Comments
 (0)