File: README.md

package info (click to toggle)
golang-github-pingcap-kvproto 6.1.0~alpha-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,040 kB
  • sloc: sh: 111; makefile: 34
file content (31 lines) | stat: -rw-r--r-- 732 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# kvproto

Protocol buffer files for TiKV

# Usage

+ Write your own protocol file in proto folder.
+ If you need to update raft-rs, please download the proto file
    respectively and overwrite the one in include folder.
+ Run `make` to generate go and rust code.
    We generate all go codes in pkg folder and rust in src folder.
+ Update the dependent projects.

# Dependencies

* Rust
* Go
* Protoc 3.8.0

# Docker image

The easiest way to compile the protobufs is to use docker.

```
./scripts/docker-build.sh  # build the docker image once
./scripts/docker-run.sh make go
```

# Build locally

There are many dependencies to be installed, please refer to the relevant scripts in [workflow](.github/workflows) to set them up.