提交 77b9ef47 编写于 作者: martianzhang's avatar martianzhang

update doc

上级 676a5ce7
......@@ -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加黑名单
......
......@@ -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
......
......@@ -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
```
### 开发调试
......
## 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
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册