Skip to content

Commit

Permalink
Update README.md (#137)
Browse files Browse the repository at this point in the history
Add links to Fabric and fabfile.py from Narwhal README
  • Loading branch information
Clay-Mysten authored Apr 18, 2022
1 parent 0cfbe23 commit 7ac7878
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions narwhal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ $ git clone https://github.com/mystenlabs/narwhal.git
$ cd narwhal/benchmark
$ pip install -r requirements.txt
```
You also need to install [Clang](https://clang.llvm.org/) (required by RocksDB) and [tmux](https://linuxize.com/post/getting-started-with-tmux/#installing-tmux) (which runs all nodes and clients in the background). Finally, run a local benchmark using fabric:
You also need to install [Clang](https://clang.llvm.org/) (required by RocksDB) and [tmux](https://linuxize.com/post/getting-started-with-tmux/#installing-tmux) (which runs all nodes and clients in the background). Finally, run a local benchmark using [Fabric](http://www.fabfile.org/):
```
$ fab local
```
This command may take a long time the first time you run it (compiling rust code in `release` mode may be slow), and you can customize a number of benchmark parameters in `fabfile.py`. When the benchmark terminates, it displays a summary of the execution similarly to the one below.
This command may take a long time the first time you run it (compiling rust code in `release` mode may be slow), and you can customize a number of benchmark parameters in [fabfile.py](https://github.com/mystenlabs/narwhal/blob/main/benchmark/fabfile.py). When the benchmark terminates, it displays a summary of the execution similarly to the one below.
```
-----------------------------------------
SUMMARY:
Expand Down

0 comments on commit 7ac7878

Please sign in to comment.