Improve compile docs (#263)

Update README to add example
TuGraph-family · Jul 26, 2023 · 165d92b · 165d92b
1 parent 31ec238
commit 165d92b
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -41,12 +41,25 @@ For more details, please refer to [quick start doc](docs/en-US/source/3.quick-st
 It's recommended to build TuGraph in linux system, and docker environment is a good choice. If you want to setup a new environment, please refer to [Dockerfile](ci/images).
 
 Here are steps to compile TuGraph:
-1. `deps/build_deps.sh` or `SKIP_WEB=1 deps/build_deps.sh` to skip building web interface
+1. `deps/build_deps.sh` or to skip building web interface `SKIP_WEB=1 deps/build_deps.sh` 
 2. `cmake .. -DOURSYSTEM=centos` or `cmake .. -DOURSYSTEM=ubuntu`
 3. If support shell lgraph_cypher, use `-DENABLE_PREDOWNLOAD_DEPENDS_PACKAGE=1`
 4. `make`
 5. `make package` or `cpack --config CPackConfig.cmake`
 
+Example:
+`tugraph/tugraph-compile-centos7`Docker environment
+
+```bash
+$ git clone --recursive https://github.com/TuGraph-family/tugraph-db.git
+$ cd tugraph-db
+$ deps/build_deps.sh
+$ mkdir build && cd build
+$ cmake .. -DOURSYSTEM=centos -DENABLE_PREDOWNLOAD_DEPENDS_PACKAGE=1
+$ make
+$ make package
+```
+
 ## 4. Develop
 
 We have prepared environment docker images for compiling in DockerHub, named `tugraph/tugraph-compile-[os]:[compile version]`, 

diff --git a/README_CN.md b/README_CN.md
@@ -37,11 +37,23 @@ TuGraph的文档在[链接](https://tugraph-db.readthedocs.io/zh_CN/latest)，
 建议在Linux系统中构建TuGraph，Docker环境是个不错的选择。如果您想设置一个新的环境，请参考[Dockerfile](ci/images).
 
 以下是编译TuGraph的步骤：
-1. `deps/build_deps.sh` or `SKIP_WEB=1 deps/build_deps.sh` to skip building web interface
-2. `cmake .. -DOURSYSTEM=centos` or `cmake .. -DOURSYSTEM=ubuntu`
-3. If support shell lgraph_cypher, use `-DENABLE_PREDOWNLOAD_DEPENDS_PACKAGE=1`
-4. `make`
-5. `make package` or `cpack --config CPackConfig.cmake`
+
+1. 如果需要web接口运行`deps/build_deps.sh`，不需要web接口则运行`SKIP_WEB=1 deps/build_deps.sh`
+2. 根据容器系统信息执行`cmake .. -DOURSYSTEM=centos`或者`cmake .. -DOURSYSTEM=ubuntu`，如果需要shell运行lgraph_cypher，加上`-DENABLE_PREDOWNLOAD_DEPENDS_PACKAGE=1`
+3. `make`
+4. `make package` 或者 `cpack --config CPackConfig.cmake`
+
+示例：`tugraph/tugraph-compile-centos7`Docker环境
+
+```bash
+$ git clone --recursive https://github.com/TuGraph-family/tugraph-db.git
+$ cd tugraph-db
+$ deps/build_deps.sh
+$ mkdir build && cd build
+$ cmake .. -DOURSYSTEM=centos -DENABLE_PREDOWNLOAD_DEPENDS_PACKAGE=1
+$ make
+$ make package
+```
 
 ## 4. 开发