Skip to content

Commit cb74e3a

Browse files
author
wenyuxuan
committed
Add English Readme
1 parent 8327b2e commit cb74e3a

File tree

8 files changed

+125
-174
lines changed

8 files changed

+125
-174
lines changed

vermeer/README.md

+46-31
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,62 @@
1-
# 图计算平台
1+
# Vermeer Graph Compute Engine
22

3-
### grpc protobuf 依赖项安装
3+
## Introduction
4+
Vermeer is a high-performance distributed graph computing platform based on memory, supporting more than 15 graph algorithms, custom algorithm extensions, and custom data source access.
5+
6+
## Start
7+
8+
```
9+
master: ./vermeer --env=master
10+
worker: ./vermeer --env=worker01
11+
```
12+
The parameter env specifies the name of the configuration file in the useconfig folder.
13+
14+
```
15+
./vermeer.sh start master
16+
./vermeer.sh start worker
17+
```
18+
Configuration items are specified in vermeer.sh
19+
## supervisord
20+
Can be used with supervisord to start and stop services, automatically start applications, rotate logs, and more; for the configuration file, refer to config/supervisor.conf;
21+
22+
Configuration file reference config/supervisor.conf
423

524
````
6-
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0 \
7-
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
25+
# run as daemon
26+
./supervisord -c supervisor.conf -d
827
````
928

29+
## Compile
30+
Required
31+
* go 1.23
32+
33+
### Install dependencies
34+
35+
```
36+
go mod tidy
37+
```
38+
39+
### Local compile
40+
41+
```
42+
go build
43+
```
44+
1045
---
1146

12-
### protobuf build
47+
### install grpc protobuf dependencies
48+
````
49+
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0 \
50+
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
51+
````
1352

53+
### protobuf build
1454
````
1555
../../tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
1656
````
1757

18-
---
1958

20-
### 交叉编译
59+
### Cross Compile
2160

2261
````
2362
linux: GOARCH=amd64 GOOS=linux go build
@@ -26,32 +65,8 @@ CC=x86_64-linux-musl-gcc CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -buildmo
2665

2766
---
2867

29-
### 运行
30-
31-
```
32-
master: ./vermeer --env=master
33-
worker: ./vermeer --env=worker01
34-
# 参数env是指定使用config文件夹下的配置文件名
35-
or
36-
./vermeer.sh start master
37-
./vermeer.sh start worker
38-
# 配置项在vermeer.sh中指定
39-
```
40-
41-
---
4268

43-
## supervisord
4469

45-
配置文件参考 config/supervisor.conf
4670

47-
````
48-
# 启动 run as daemon
49-
./supervisord -c supervisor.conf -d
50-
````
5171

52-
# 使用hubble平台
53-
有三种搭建方式,参考https://hugegraph.apache.org/docs/quickstart/hugegraph-hubble/
5472

55-
Use Docker (Convenient for Test/Dev)
56-
Download the Toolchain binary package
57-
Source code compilation

vermeer/README.zh-CN.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Vermeer图计算平台
2+
3+
## 简介
4+
Vermeer是一个基于内存的高性能分布式图计算平台,支持15+图算法。支持自定义算法扩展,支持自定义数据源接入。
5+
6+
## 运行
7+
8+
```
9+
master: ./vermeer --env=master
10+
worker: ./vermeer --env=worker01
11+
```
12+
参数env是指定使用config文件夹下的配置文件名
13+
14+
```
15+
./vermeer.sh start master
16+
./vermeer.sh start worker
17+
```
18+
配置项在vermeer.sh中指定
19+
20+
21+
## supervisord
22+
可搭配supervisord使用,启动和停止服务,应用自动拉起、日志轮转等功能;
23+
24+
配置文件参考 config/supervisor.conf
25+
26+
````
27+
# 启动 run as daemon
28+
./supervisord -c supervisor.conf -d
29+
````
30+
31+
## 编译
32+
33+
* Go 1.23
34+
35+
### 安装依赖项
36+
37+
```
38+
go mod tidy
39+
```
40+
41+
### 本地编译
42+
43+
```
44+
go build
45+
```
46+
47+
### grpc protobuf 依赖项安装
48+
````
49+
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0 \
50+
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
51+
````
52+
53+
54+
55+
### protobuf build
56+
生成protobuf文件
57+
````
58+
../../tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
59+
````
60+
61+
62+
63+
### 交叉编译
64+
65+
````
66+
linux: GOARCH=amd64 GOOS=linux go build
67+
CC=x86_64-linux-musl-gcc CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -buildmode=plugin
68+
````
69+
70+
---
71+
72+
73+
74+
# 使用hubble平台
75+
有三种搭建方式,参考https://hugegraph.apache.org/docs/quickstart/hugegraph-hubble/
76+
77+
Use Docker (Convenient for Test/Dev)
78+
Download the Toolchain binary package
79+
Source code compilation

vermeer/config/worker04.ini

-24
This file was deleted.

vermeer/config/worker05.ini

-24
This file was deleted.

vermeer/config/worker06.ini

-24
This file was deleted.

vermeer/config/worker07.ini

-24
This file was deleted.

vermeer/config/worker08.ini

-24
This file was deleted.

vermeer/config/worker09.ini

-23
This file was deleted.

0 commit comments

Comments
 (0)