From ed6283dca40d331a4af52e71e086ac8d77ffd973 Mon Sep 17 00:00:00 2001 From: James Mills <1290234+prologic@users.noreply.github.com> Date: Mon, 1 Apr 2019 17:27:56 +1000 Subject: [PATCH] Add Development section to README documenting use of Protobuf and tooling required. #6 --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 4a491b0..a8b4610 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,30 @@ For a more feature-complete Redis-compatible server, distributed key/value store * Low latecny * High throughput (See: [Performance](README.md#Performance) +## Development + +1. Get the source: + +```#!bash +$ git clone https://github.com/prologic/bitcask.git +``` + +2. Install required tools: + +This library uses [Protobuf](https://github.com/protocolbuffers/protobuf) to serialize data on disk. Please follow the +instructions for installing `protobuf` on your system. You will also need the +following Go libraries/tools to generate Go code from Protobuf defs: + +3. Build the project: + +```#!bash +$ make +``` + +This will invoke `go generate` and `go build`. + +- [protoc-gen-go](https://github.com/golang/protobuf) + ## Install ```#!bash