[
https://issues.apache.org/jira/browse/SCB-395?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16396699#comment-16396699
]
ASF GitHub Bot commented on SCB-395:
------------------------------------
WillemJiang closed pull request #151: SCB-395 add guides to build executable
files
URL: https://github.com/apache/incubator-servicecomb-saga/pull/151
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/README.md b/README.md
index 41903393..2074ed33 100644
--- a/README.md
+++ b/README.md
@@ -23,8 +23,7 @@ See [Saga Pack Design](docs/design.md) for details.
See [Booking Demo](saga-demo/booking/README.md) for details.
## User Guide
-See [User Guide](docs/user_guide.md) for details.
-
+How to build and use can refer to [User Guide](docs/user_guide.md).
## FAQ
* [How to use MySQL as alpha's backend
database?](docs/faq/en/how_to_use_mysql_as_alpha_backend_database.md)
diff --git a/README_ZH.md b/README_ZH.md
index 1b055926..98bf460c 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -23,7 +23,7 @@ Saga是由 **alpha** 和 **omega**组成，其中：
详情可浏览[出行预订示例](saga-demo/booking/README.md)。
## 用户指南
-详情可浏览[用户指南](docs/user_guide_zh.md)。
+如何构建和使用可浏览[用户指南](docs/user_guide_zh.md)。
## 常见问题
*
[如何使用MySQL作为alpha的后台数据库？](docs/faq/cn/how_to_use_mysql_as_alpha_backend_database.md)
diff --git a/docs/user_guide.md b/docs/user_guide.md
index 62eadc7b..445fadc7 100644
--- a/docs/user_guide.md
+++ b/docs/user_guide.md
@@ -12,7 +12,27 @@ You will need:
[docker]: https://www.docker.com/get-docker
## Build
-To build:
+
+Retrieve the source code:
+```bash
+$ git clone https://github.com/apache/incubator-servicecomb-saga.git
+$ cd incubator-servicecomb-saga
+```
+
+Saga can be built in either of the following ways.
+* Only build the executable files.
+ ```bash
+ $ mvn clean install -DskipTests
+ ```
+
+* build the executable files along with docker image.
+ ```bash
+ $ mvn clean install -DskipTests -Pdocker
+ ```
+
+After executing either one of the above command, you will find alpha server's
executable file in
`alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`.
+
+### Build executable files and docker images
```bash
$ git clone https://github.com/apache/incubator-servicecomb-saga.git
$ cd incubator-servicecomb-saga
diff --git a/docs/user_guide_zh.md b/docs/user_guide_zh.md
index befc97c7..ad1247dd 100644
--- a/docs/user_guide_zh.md
+++ b/docs/user_guide_zh.md
@@ -11,13 +11,26 @@
[docker]: https://www.docker.com/get-docker
## 编译
-编译Saga，只需以下几步：
+
+获取源码：
```bash
$ git clone https://github.com/apache/incubator-servicecomb-saga.git
$ cd incubator-servicecomb-saga
-$ mvn clean install -DskipTests -Pdocker
```
+Saga可通过以下任一方式进行构建：
+* 只构建可执行文件：
+ ```bash
+ $ mvn clean install -DskipTests
+ ```
+
+* 同时构建可执行文件和docker镜像：
+ ```bash
+ $ mvn clean install -DskipTests -Pdocker
+ ```
+
+在执行以上任一指令后，可在`alpha/alpha-server/target/saga/alpha-server-${version}-exec.jar`中找到alpha
server的可执行文件。
+
## 如何使用
### 引入Saga的依赖
```xml
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Add How to build into README file
> ---------------------------------
>
> Key: SCB-395
> URL: https://issues.apache.org/jira/browse/SCB-395
> Project: Apache ServiceComb
> Issue Type: Improvement
> Components: Saga
> Reporter: Willem Jiang
> Assignee: Eric Lee
> Priority: Minor
> Fix For: saga-0.1.0
>
>
> Current README doesn't has the section of how to build the binary from source.
> As we have some docker image need to be generated, we need to tell the user
> about it in the README.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
