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 With regards, Apache Git Services
