Skip to content

Commit

Permalink
Add build prerequisites to readme (#756)
Browse files Browse the repository at this point in the history
Co-authored-by: Ron Kuris <ron.kuris@avalabs.org>
  • Loading branch information
sergerad and rkuris authored Nov 26, 2024
1 parent 02aba8e commit ded2f28
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,20 @@ Firewood guarantees recoverability by not referencing the new nodes in a new rev
- [ ] Implement a node cache
- [ ] Hook up the RPC

## Build

In order to build firewood, `protoc` must be installed. See instructions for installation [here](https://grpc.io/docs/protoc-installation/).

On Mac, you can install via brew:
```
brew install protobuf
```

## Run

There are several examples, in the examples directory, that simulate real world
use-cases. Try running them via the command-line, via `cargo run --release
--example simple`.
--example insert`.

For maximum performance, use `cargo run --maxperf` instead, which enables maximum
link time compiler optimizations, but takes a lot longer to compile.
Expand Down

0 comments on commit ded2f28

Please sign in to comment.