From 77b9ef47ace38c4b65acb1cc9abe48dd7d926e61 Mon Sep 17 00:00:00 2001 From: Leon Zhang Date: Sat, 20 Oct 2018 01:32:28 +0800 Subject: [PATCH] update doc --- Makefile | 2 +- README.md | 2 +- doc/install.md | 5 ++--- doc/install_en.md | 10 ++++++---- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index b4c4154..e9d1ae4 100644 --- a/Makefile +++ b/Makefile @@ -123,7 +123,7 @@ vendor: vitess tidb .PHONY: tidb-parser tidb-parser: tidb @echo "\033[92mimporting tidb sql parser ...\033[0m" - @cd ${GOPATH}/src/github.com/pingcap/tidb && git checkout -b soar ec9672cea6612481b1da845dbab620b7a5581ca4 && make parser + @cd ${GOPATH}/src/github.com/pingcap/tidb && git checkout ec9672cea6612481b1da845dbab620b7a5581ca4 && make parser # gometalinter # 如果有不想改的lint问题可以使用metalinter.sh加黑名单 diff --git a/README.md b/README.md index 45115ab..a565518 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ SOAR(SQL Optimizer And Rewriter)是一个对SQL进行优化和改写的自动化 * 欢迎通过Github Issues提交问题报告与建议 * QQ群: 779359816 -* [Gitter](https://gitter.im/xiaomi-dba/soar) +* [Gitter](https://gitter.im/xiaomi-dba/soar) 推荐 ## License diff --git a/doc/install.md b/doc/install.md index e270855..e2551d8 100644 --- a/doc/install.md +++ b/doc/install.md @@ -26,9 +26,8 @@ wget https://github.com/XiaoMi/soar/releases/download/v0.8.0/soar.linux-amd64 -O ### 生成二进制文件 ```bash -TODO: 开源后可直接从github执行go get下载,未开源前需要git clone到指定路径 -go get github.com/XiaoMi/soar -cd ${GOPATH}/github.com/XiaoMi/soar && make +go get github.com/XiaoMi/soar/... +cd ${GOPATH}/src/github.com/XiaoMi/soar && make ``` ### 开发调试 diff --git a/doc/install_en.md b/doc/install_en.md index e6ea5b1..bb23819 100644 --- a/doc/install_en.md +++ b/doc/install_en.md @@ -1,15 +1,17 @@ ## Get Released Binary ```bash -TODO: -wget http://... +wget https://github.com/XiaoMi/soar/releases/download/${tag}/soar.linux-amd64 -O soar + +eg. +wget https://github.com/XiaoMi/soar/releases/download/v0.8.0/soar.linux-amd64 -O soar ``` ## Build From Source ```bash -go get github.com/XiaoMi/soar -cd $GOPATH/github.com/XiaoMi/soar && make +go get github.com/XiaoMi/soar/... +cd ${GOPATH}/src/github.com/XiaoMi/soar && make ``` ## Simple Test Case -- GitLab