Skip to content

Commit b33e700

Browse files
committed
feat: add API documentation and architectural design for Vermeer
1 parent deacfd9 commit b33e700

File tree

3 files changed

+1560
-0
lines changed

3 files changed

+1560
-0
lines changed

vermeer/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Vermeer
2+
Vermeer is a high-performance graph computing framework implemented in the Go language, mainly focusing on memory-based, with the latest version compatible with some data being stored on disk.
3+
4+
## Architecture Design
5+
[Vermeer Architecture](docs/architecture.md)
6+
7+
## Build
8+
9+
### grpc protobuf Dependency installation
10+
````
11+
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0 \
12+
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
13+
````
14+
15+
### protobuf build
16+
17+
````
18+
../../tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
19+
````
20+
21+
### Cross-compilation
22+
23+
````
24+
linux: GOARCH=amd64 GOOS=linux go build
25+
CC=x86_64-linux-musl-gcc CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -buildmode=plugin
26+
````
27+
28+
## Run
29+
30+
```
31+
master: ./vermeer --env=master
32+
worker: ./vermeer --env=worker01
33+
# The parameter `env` specifies the configuration file name under the `config` folder.
34+
```
35+
OR
36+
37+
```
38+
./vermeer.sh start master
39+
./vermeer.sh start worker
40+
# The configuration items are specified in the vermeer.sh file.
41+
```
42+
43+
44+
## API Doc
45+
[Vermeer API](docs/api.md)
46+
47+

0 commit comments

Comments
 (0)