doc(make): add make doc

2021-10-22 16:26:17 +08:00 · 2021-10-22 16:26:17 +08:00 · 77988052ee
parent e6eb86de05
commit 77988052ee
2 changed files with 32 additions and 17 deletions
--- a/doc/make.md
+++ b/doc/make.md
@ -0,0 +1,32 @@
+### 构建工具文档
+
+#### dcgen
+1. 根据结构体接口模板生成 proto 文件
+2. 迁移 proto 到 pkg/proto 下
+3. 更新结构体常量
+
+>PS : 开发一个 storage 的新接口时一般有以下步骤
+>1. 修改 storage 接口配置文件
+>2. make dcgen
+>3. 修改生成的 proto 文件
+>4. make dcgen
+>5. 添加 storage 的操作接口 
+
+
+#### build-storage
+编译并且生成 /bin/storage
+
+#### build-gateway
+编译并且生成 /bin/gateway
+
+#### install
+1. 安装项目，需要 sudo
+
+#### storage
+根据配置文件启动 storage
+
+#### gateway
+根据配置文件启动 gateway
+
+#### init-conf
+根据配置文件文档初始化配置文件到 /etc/wheat-cache/wheat-cache.yaml 
--- a/doc/make/make.md
+++ b/doc/make/make.md
@ -1,17 +0,0 @@
-## 构建工具文档
-
-### 构建 proto （grpc-go）
-```shell
-make dcgen
-```
-
-### 编译全部的 go 项目
-```shell
-make build
-```
-
-### 启动 storage 服务
-```shell
-make dev
-```
-### 根据配置生成 结构体命令