diff --git a/doc.go b/doc.go new file mode 100644 index 0000000000000000000000000000000000000000..3c347f0f8f0e6808c0c4ebdf21f916aa55d0967b --- /dev/null +++ b/doc.go @@ -0,0 +1,18 @@ +/* + * Copyright 2018 Xiaomi, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Package soar is a command-line tool for SQL optimizing and rewriting. +package soar diff --git a/doc/install.md b/doc/install.md index daf63025dab6d0d1d3f0b457c92d80c9ab22a6a8..b4e04aef197fceb95729b74a03801c4797b5e7d8 100644 --- a/doc/install.md +++ b/doc/install.md @@ -27,7 +27,7 @@ chmod a+x soar ### 生成二进制文件 ```bash -go get github.com/XiaoMi/soar/... +go get -d 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 95ed3731bd22d08caea66763797e7eaf7df88651..08363fa4ddc56e47b32a14fffbd77262611a64a5 100644 --- a/doc/install_en.md +++ b/doc/install_en.md @@ -11,7 +11,7 @@ chmod a+x soar ## Build From Source ```bash -go get github.com/XiaoMi/soar/... +go get -d github.com/XiaoMi/soar cd ${GOPATH}/src/github.com/XiaoMi/soar && make ```