更新文档

README.md

@@ -1,2 +1,58 @@
-# gva-ctl
-A friendly terminal tool that is convenient to use the [gin-vue-admin](https://github.com/flipped-aurora/gin-vue-admin) project
+# 介绍
+gva-ctl:一个友好的终端工具，方便使用 [gin-vue-admin](https://github.com/flipped-aurora/gin-vue-admin) 项目
+
+# 构建终端工具
+Mac系统可使用Makefile进行打包应用
+```shell script
+git clone https://github.com/flipped-aurora/gva-ctl.git
+make mac-build
+mv gva $GOPATH/bin/gva
+```
+
+Linux系统也可使用Makefile进行打包应用
+```shell script
+git clone https://github.com/flipped-aurora/gva-ctl.git
+make linux-build
+mv gva $GOPATH/bin/gva
+```
+
+windows系统用户
+- 很抱歉不支持使用Makefile的命令(这不是项目不支持Makefile,而是windows系统不支持的,请谅解!)
+- 你可以使用以下命令进行构建终端
+```shell script
+git clone https://github.com/flipped-aurora/gva-ctl.git
+CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o gva.exe
+mv gva $GOPATH/bin/gva
+```
+
+# 贡献指南
+- Issue
+    - issues 可提交bug和建议
+    - 在提交 issue 之前，请搜索相关内容是否已被提出
+- Pull Request
+    - 请先 fork 一份到自己的项目下，不要直接在仓库下建分支。
+    - commit 信息要以[文件名]: 描述信息 的形式填写，例如 README.md: fix xxx bug。
+    - 确保 PR 是提交到 develop 分支，而不是 master 分支。
+    - 如果是修复 bug，请在 PR 中给出描述信息。
+    - 合并代码需要两名维护人员参与：一人进行 review 后 approve，另一人再次 review，通过后即可合并
+- 版本信息
+    - v0.0.1
+        - 支持mysql(完美支持)与postgresql(慎用)
+
+# 使用指南
+- clone或者download [gin-vue-admin](https://github.com/flipped-aurora/gin-vue-admin) 项目
+```shell script
+git clone https://github.com/flipped-aurora/gin-vue-admin.git
+```
+- 进入server项目
+```shell script
+cd server
+```
+- 按需修改 [server](https://github.com/flipped-aurora/gin-vue-admin/tree/master/server) 的 [config.yaml](https://github.com/flipped-aurora/gin-vue-admin/blob/master/server/config.yaml) 文件
+- 修改完成后使用 [gva](#构建终端工具) 终端工具进行生成表和初始数据
+```shell script
+gva initdb
+# 当你看以下文本输出就代表初始化成功了
+[Mysql]-->初始化数据表成功
+[Mysql]-->初始化数据成功
+```