From 77988052eeacb50f04148b0d4971d4b148d45293 Mon Sep 17 00:00:00 2001 From: bandl <1658002533@qq.com> Date: Fri, 22 Oct 2021 16:26:17 +0800 Subject: [PATCH] doc(make): add make doc --- doc/make.md | 32 ++++++++++++++++++++++++++++++++ doc/make/make.md | 17 ----------------- 2 files changed, 32 insertions(+), 17 deletions(-) create mode 100644 doc/make.md delete mode 100644 doc/make/make.md diff --git a/doc/make.md b/doc/make.md new file mode 100644 index 0000000..57e4227 --- /dev/null +++ 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 diff --git a/doc/make/make.md b/doc/make/make.md deleted file mode 100644 index b0afd4e..0000000 --- a/doc/make/make.md +++ /dev/null @@ -1,17 +0,0 @@ -## 构建工具文档 - -### 构建 proto (grpc-go) -```shell -make dcgen -``` - -### 编译全部的 go 项目 -```shell -make build -``` - -### 启动 storage 服务 -```shell -make dev -``` -### 根据配置生成 结构体命令