From c9d9cafa930741b58e9583d6b1fc9504d8a65bd1 Mon Sep 17 00:00:00 2001
From: Kent Yao <yaooqinn@hotmail.com>
Date: Mon, 9 Apr 2018 15:59:29 +0800
Subject: [PATCH] doc updated

---
 README.md                         | 10 +-------
 docs/building.md                  | 38 +++++++++++++++++++++++++++++++
 README_CN.md => docs/readme_cn.md |  0
 3 files changed, 39 insertions(+), 9 deletions(-)
 create mode 100644 docs/building.md
 rename README_CN.md => docs/readme_cn.md (100%)

diff --git a/README.md b/README.md
index ec410d36b..818f79d51 100644
--- a/README.md
+++ b/README.md
@@ -30,13 +30,7 @@ But unfortunately, due to the limitations of Spark's own architecture，to be us
 
 ### Packaging
 
-**Kyuubi** server is built based on [Apache Maven](http://maven.apache.org), 
-
-```sbtshell
-build/mvn clean package -DskipTests
-```
-
-Running the code above in the Kyuubi project directory is all we need to build a runnable Kyuubi server.
+Please refer to the [Building Kyuubi](docs/building.md) in the online documentation for an overview on how to build Kyuubi.
 
 ### Start Kyuubi
 
@@ -94,8 +88,6 @@ Now you can use [beeline](https://cwiki.apache.org/confluence/display/Hive/HiveS
 ```bash
 bin/stop-kyuubi.sh
 ```
-
-
 **Notes:** Obviously，without the patches we supplied, Kyuubi is mostly same with the Thrift JDBC/ODBC Server as an non-mutli-tenancy server. 
 
 ## Multi Tenancy Support
diff --git a/docs/building.md b/docs/building.md
new file mode 100644
index 000000000..60bf03e94
--- /dev/null
+++ b/docs/building.md
@@ -0,0 +1,38 @@
+# Building Kyuui
+
+## Building Kyuubi with Apache Maven
+**Kyuubi** server is built based on [Apache Maven](http://maven.apache.org),
+
+```bash
+./build/mvn clean package -DskipTests
+```
+
+Running the code above in the Kyuubi project root directory is all we need to build a runnable Kyuubi server.
+
+## Building a Runnable Distribution
+
+To create a Kyuubi distribution like those distributed by [Kyuubi Release Page](https://github.com/yaooqinn/kyuubi/releases),
+and that is laid out so as to be runnable, use `./build/dist` in the project root directory.
+
+Example:
+```bash
+./build/dist --name custom-name --tgz
+```
+
+This will build a Kyuubi distribution name `kyuubi-{version}-bin-custom-name.tar.gz`. For more information on usage,
+run `./build/dist --help`
+
+## Running Tests
+The following is an example of a command to run the tests:
+
+```bash
+./build/mvn clean test
+```
+
+With Maven, you can use the -DwildcardSuites flag to run individual Scala tests:
+
+```bash
+./build/mvn -Dtest=none -DwildcardSuites=yaooqinn.kyuubi.operation.OperationTypeSuite test
+```
+
+For more information about the ScalaTest Maven Plugin, refer to the [ScalaTest documentation](http://www.scalatest.org/user_guide/using_the_scalatest_maven_plugin).
diff --git a/README_CN.md b/docs/readme_cn.md
similarity index 100%
rename from README_CN.md
rename to docs/readme_cn.md