Skip to content

Commit

Permalink
Merge 4ad8ea1 into dbac344
Browse files Browse the repository at this point in the history
  • Loading branch information
eric-lee-ltk committed Mar 13, 2018
2 parents dbac344 + 4ad8ea1 commit 9d1db82
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 6 deletions.
3 changes: 1 addition & 2 deletions README.md
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion README_ZH.md
Expand Up @@ -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)
Expand Down
22 changes: 21 additions & 1 deletion docs/user_guide.md
Expand Up @@ -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
Expand Down
17 changes: 15 additions & 2 deletions docs/user_guide_zh.md
Expand Up @@ -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
Expand Down

0 comments on commit 9d1db82

Please sign in to comment.