This is an automated email from the ASF dual-hosted git repository.
jin pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/incubator-hugegraph-computer.git
commit 3426a2c4046bbca9274a98483ee24b717646a1f5
Author: wenyuxuan <wenyux...@baidu.com>
AuthorDate: Sun Apr 27 17:16:39 2025 +0800
Add English Readme
---
vermeer/README.md | 77 ++++++++++++++++++++--------------
vermeer/{README.md => README.zh-CN.md} | 74 ++++++++++++++++++++------------
vermeer/config/worker04.ini | 24 -----------
vermeer/config/worker05.ini | 24 -----------
vermeer/config/worker06.ini | 24 -----------
vermeer/config/worker07.ini | 24 -----------
vermeer/config/worker08.ini | 24 -----------
vermeer/config/worker09.ini | 23 ----------
8 files changed, 94 insertions(+), 200 deletions(-)
diff --git a/vermeer/README.md b/vermeer/README.md
index f2f0fc78..77695662 100644
--- a/vermeer/README.md
+++ b/vermeer/README.md
@@ -1,23 +1,62 @@
-# 图计算平台
+# Vermeer Graph Compute Engine
-### grpc protobuf 依赖项安装
+## Introduction
+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.
+
+## Start
+
+```
+master: ./vermeer --env=master
+worker: ./vermeer --env=worker01
+```
+The parameter env specifies the name of the configuration file in the
useconfig folder.
+
+```
+./vermeer.sh start master
+./vermeer.sh start worker
+```
+Configuration items are specified in vermeer.sh
+## supervisord
+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;
+
+Configuration file reference config/supervisor.conf
````
-go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0 \
-go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
+# run as daemon
+./supervisord -c supervisor.conf -d
````
+## Compile
+Required
+* go 1.23
+
+### Install dependencies
+
+```
+go mod tidy
+```
+
+### Local compile
+
+```
+go build
+```
+
---
-### protobuf build
+### install grpc protobuf dependencies
+````
+go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0 \
+go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
+````
+### protobuf build
````
../../tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
````
----
-### 交叉编译
+### Cross Compile
````
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
---
-### 运行
-
-```
-master: ./vermeer --env=master
-worker: ./vermeer --env=worker01
-# 参数env是指定使用config文件夹下的配置文件名
-or
-./vermeer.sh start master
-./vermeer.sh start worker
-# 配置项在vermeer.sh中指定
-```
-
----
-## supervisord
-配置文件参考 config/supervisor.conf
-````
-# 启动 run as daemon
-./supervisord -c supervisor.conf -d
-````
-# 使用hubble平台
-有三种搭建方式，参考https://hugegraph.apache.org/docs/quickstart/hugegraph-hubble/
-Use Docker (Convenient for Test/Dev)
-Download the Toolchain binary package
-Source code compilation
diff --git a/vermeer/README.md b/vermeer/README.zh-CN.md
similarity index 63%
copy from vermeer/README.md
copy to vermeer/README.zh-CN.md
index f2f0fc78..34dcec04 100644
--- a/vermeer/README.md
+++ b/vermeer/README.zh-CN.md
@@ -1,21 +1,64 @@
-# 图计算平台
+# Vermeer图计算平台
-### grpc protobuf 依赖项安装
+## 简介
+Vermeer是一个基于内存的高性能分布式图计算平台，支持15+图算法。支持自定义算法扩展，支持自定义数据源接入。
+
+## 运行
+
+```
+master: ./vermeer --env=master
+worker: ./vermeer --env=worker01
+```
+参数env是指定使用config文件夹下的配置文件名
+
+```
+./vermeer.sh start master
+./vermeer.sh start worker
+```
+配置项在vermeer.sh中指定
+
+
+## supervisord
+可搭配supervisord使用，启动和停止服务，应用自动拉起、日志轮转等功能；
+
+配置文件参考 config/supervisor.conf
+````
+# 启动 run as daemon
+./supervisord -c supervisor.conf -d
+````
+
+## 编译
+
+* Go 1.23
+
+### 安装依赖项
+
+```
+go mod tidy
+```
+
+### 本地编译
+
+```
+go build
+```
+
+### grpc protobuf 依赖项安装
````
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0 \
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
````
----
-### protobuf build
+### protobuf build
+生成protobuf文件
````
../../tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
````
----
+
### 交叉编译
@@ -26,28 +69,7 @@ CC=x86_64-linux-musl-gcc CGO_ENABLED=1 GOOS=linux
GOARCH=amd64 go build -buildmo
---
-### 运行
-```
-master: ./vermeer --env=master
-worker: ./vermeer --env=worker01
-# 参数env是指定使用config文件夹下的配置文件名
-or
-./vermeer.sh start master
-./vermeer.sh start worker
-# 配置项在vermeer.sh中指定
-```
-
----
-
-## supervisord
-
-配置文件参考 config/supervisor.conf
-
-````
-# 启动 run as daemon
-./supervisord -c supervisor.conf -d
-````
# 使用hubble平台
有三种搭建方式，参考https://hugegraph.apache.org/docs/quickstart/hugegraph-hubble/
diff --git a/vermeer/config/worker04.ini b/vermeer/config/worker04.ini
deleted file mode 100644
index 53dffe31..00000000
--- a/vermeer/config/worker04.ini
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
-
-[default]
-log_level=info
-debug_mode=release
-http_peer=0.0.0.0:10188
-grpc_peer=0.0.0.0:10189
-master_peer=127.0.0.1:6689
-run_mode=worker
\ No newline at end of file
diff --git a/vermeer/config/worker05.ini b/vermeer/config/worker05.ini
deleted file mode 100644
index 57e43ada..00000000
--- a/vermeer/config/worker05.ini
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
-
-[default]
-log_level=info
-debug_mode=release
-http_peer=0.0.0.0:10288
-grpc_peer=0.0.0.0:10289
-master_peer=127.0.0.1:6689
-run_mode=worker
\ No newline at end of file
diff --git a/vermeer/config/worker06.ini b/vermeer/config/worker06.ini
deleted file mode 100644
index 212c7a8f..00000000
--- a/vermeer/config/worker06.ini
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
-
-[default]
-log_level=info
-debug_mode=release
-http_peer=0.0.0.0:10388
-grpc_peer=0.0.0.0:10389
-master_peer=127.0.0.1:6689
-run_mode=worker
\ No newline at end of file
diff --git a/vermeer/config/worker07.ini b/vermeer/config/worker07.ini
deleted file mode 100644
index 3ac781fc..00000000
--- a/vermeer/config/worker07.ini
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
-
-[default]
-log_level=info
-debug_mode=release
-http_peer=0.0.0.0:10488
-grpc_peer=0.0.0.0:10489
-master_peer=127.0.0.1:6689
-run_mode=worker
\ No newline at end of file
diff --git a/vermeer/config/worker08.ini b/vermeer/config/worker08.ini
deleted file mode 100644
index f7501c4b..00000000
--- a/vermeer/config/worker08.ini
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
-
-[default]
-log_level=info
-debug_mode=release
-http_peer=0.0.0.0:10588
-grpc_peer=0.0.0.0:10589
-master_peer=127.0.0.1:6689
-run_mode=worker
\ No newline at end of file
diff --git a/vermeer/config/worker09.ini b/vermeer/config/worker09.ini
deleted file mode 100644
index 7f8e731d..00000000
--- a/vermeer/config/worker09.ini
+++ /dev/null
@@ -1,23 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
-[default]
-log_level=info
-debug_mode=release
-http_peer=0.0.0.0:10688
-grpc_peer=0.0.0.0:10689
-master_peer=127.0.0.1:6689
-run_mode=worker
\ No newline at end of file
