Update README & Resource

README.md

@@ -4,11 +4,9 @@
 
 随着 AI 技术的广泛应用，以及数据规模的不断增长，对非结构化数据处理的需求也日益增多。向量检索也逐渐成了 AI 技术链路中不可或缺的一环，同时也是对传统搜索技术的补充。
 
-Proxima 是阿里巴巴达摩院系统 AI 实验室自研的向量检索内核。目前，其核心能力广泛应用于阿里巴巴和蚂蚁集团内众多业务，如淘宝搜索和推荐、蚂蚁人脸支付、优酷视频搜索、阿里妈妈广告检索等。同时，Proxima
-还深度集成在各式各类的大数据和数据库产品中，如阿里云 Hologres、搜索引擎 Elastic Search 和 ZSearch、离线引擎 MaxCompute (ODPS) 等，为其提供向量检索的能力。
+Proxima 是阿里巴巴达摩院系统 AI 实验室自研的向量检索内核。目前，其核心能力广泛应用于阿里巴巴和蚂蚁集团内众多业务，如淘宝搜索和推荐、蚂蚁人脸支付、优酷视频搜索、阿里妈妈广告检索等。同时，Proxima 还深度集成在各式各类的大数据和数据库产品中，如阿里云 Hologres、搜索引擎 Elastic Search 和 ZSearch、离线引擎 MaxCompute (ODPS) 等，为其提供向量检索的能力。
 
-Proxima BE，全称 Proxima Bilin Engine，是 Proxima 团队开发的服务化引擎，实现了对大数据的高性能相似性搜索。支持 RESTful HTTP 接口访问，同时也支持多种语言的 SDK 以 GRPC
-协议访问。
+Proxima BE，全称 Proxima Bilin Engine，是 Proxima 团队开发的服务化引擎，实现了对大数据的高性能相似性搜索。支持 RESTful HTTP 接口访问，同时也支持多种语言的 SDK 以 GRPC 协议访问。
 
 ## 核心能力
 
@@ -37,18 +35,17 @@ Proxima BE 的主要核心能力有以下几点:
 
 ```shell
 git clone https://github.com/alibaba/proximabilin.git
-
 git submodule update --init
 
 mkdir build && cd build
 
-# Intel haswell 架构下 Debug 方式编译
-#cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_NEHALEM=ON ..
+# Build with Debug (Intel Haswell Microarchitecture)
+#cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_HASWELL=ON ..
 
-# Intel haswell 架构下 Release 方式编译
+# Build with Release (Intel Haswell Microarchitecture)
 cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_HASWELL=ON ..
 
-make all
+make -j all
 ```
 
 
@@ -76,11 +73,6 @@ make all
 
 [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
 
-## 如何交流
-
-* 邮箱
-* 钉钉群
-
 ## 声明
 
 Proxima BE 依赖了如下项目:

docs/README.md

@@ -1,43 +1,34 @@
-## 1 文档说明
+## 1. 文档说明
 
 该文档是 Proxima Bilin Engine 的项目文档，使用 [Hugo](https://gohugo.io/) 进行构建（使用 Docsy 主题）。
 
-## 2 文档编写方法
+
+
+## 2. 文档编写方法
 
 ### 2.1. 安装 Hugo
 
 [下载地址](https://github.com/gohugoio/hugo/releases)
 
 > **注意：**一定要安装 Extended 版本的 Hugo
 
-本文仅仅介绍 Mac 版本的安装方法，其余版本详见[官方文档](https://gohugo.io/getting-started/installing)
+本文仅仅介绍 Mac 版本的安装方法，其余版本详见[官方文档](https://gohugo.io/getting-started/installing)。
 
 下载最新的文件：
 
 ```s
 $ wget https://github.com/gohugoio/hugo/releases/download/v0.87.0/hugo_extended_0.87.0_macOS-64bit.tar.gz
 ```
 
-解压后，把可执行文件 hugo 放到 PATH 路径：
-
-```s
-$ sudo cp hugo /usr/local/bin/hugo
-```
+解压后，把可执行文件 hugo 放到 PATH 路径。
 
 验证安装：
-```s
-$ hugo version
-```
-
-### 2.2 下载 submodule 
-
-需要下载 submodule ：
 
 ```s
-git submodule update --init --recursive
+$ hugo version
 ```
 
-### 2.3 安装 SCSS
+### 2.2 安装 SCSS
 
 在`项目目录`中：
 ```s
@@ -47,30 +38,25 @@ sudo npm install -D --save postcss-cli
 
 > **注意：**需要预先安装 nodejs 才能使用 npm 命令。
 
-### 2.4 编写 Markdown 文档
+### 2.3 编写 Markdown 文档
 
 在 content/zh 对应的目录中建立 Markdown 文件，并编写文档。
 
 > **注意**: 每个 Markdown 文件需要编写头部信息，例如 `title`，`weight` 等，具体可以参考文中的示例。
 
-### 2.5 预览
+### 2.4 预览
 ```s
 $ hugo server
 ```
 
 编译后可以在 `http://localhost:1313/` 中预览
 
 
-### 2.6 编译
+### 2.5 编译
 预览没有问题则可以在编译：
 ```s
 $ hugo
 ```
 
-最后上传到 Github 即可
-
-
-
-
+最后 commit 到仓库即可。
 
-