From ded2f28cbe69c9809d6608393624eca998060644 Mon Sep 17 00:00:00 2001 From: Serge Radinovich <47865535+sergerad@users.noreply.github.com> Date: Wed, 27 Nov 2024 08:21:41 +1300 Subject: [PATCH] Add build prerequisites to readme (#756) Co-authored-by: Ron Kuris --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6e0e20ae3..a2e9bd23d 100644 --- a/README.md +++ b/README.md @@ -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.