1
0
mirror of https://github.com/taigrr/bitcask synced 2025-01-18 04:03:17 -08:00

Add Development section to README documenting use of Protobuf and tooling required. #6

This commit is contained in:
James Mills 2019-04-01 17:27:56 +10:00
parent f44b6249ac
commit ed6283dca4
No known key found for this signature in database
GPG Key ID: AC4C014F1440EBD6

View File

@ -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