This is an automated email from the ASF dual-hosted git repository. ningjiang pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-saga.git
The following commit(s) were added to refs/heads/master by this push: new 26808d9 SCB-395 add guides to build executable files 26808d9 is described below commit 26808d91b17fbe1f69a97cd08b607d185b68e0d5 Author: Eric Lee <dagang...@huawei.com> AuthorDate: Tue Mar 13 16:04:37 2018 +0800 SCB-395 add guides to build executable files Signed-off-by: Eric Lee <dagang...@huawei.com> --- README.md | 3 +-- README_ZH.md | 2 +- docs/user_guide.md | 22 +++++++++++++++++++++- docs/user_guide_zh.md | 17 +++++++++++++++-- 4 files changed, 38 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4190339..2074ed3 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 1b05592..98bf460 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 62eadc7..445fadc 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 befc97c..ad1247d 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 -- To stop receiving notification emails like this one, please contact ningji...@apache.org.