wanjia950611
/
smart-doc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update readme.md

This commit is contained in:
oppofind 2019-10-16 21:04:48 +08:00
parent f1253468d6
commit 8c575de33f
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -99,7 +99,11 @@ public class ApiDocTest {
(https://images.gitee.com/uploads/images/2018/0905/172510_853735b9_144669.png "2.png") (https://images.gitee.com/uploads/images/2018/0905/172510_853735b9_144669.png "2.png")
#### Response parameter example renderings #### Response parameter example renderings
(https://images.gitee.com/uploads/images/2018/0905/172538_1918820c_144669.png "3.png") (https://images.gitee.com/uploads/images/2018/0905/172538_1918820c_144669.png "3.png")
## Building
you can build with the following commands. (Java 1.8 is required to build the master branch)
```
mvn clean install
```
## Other reference ## Other reference
- [Smart-doc manual](https://github.com/shalousun/smart-doc/wiki) - [Smart-doc manual](https://github.com/shalousun/smart-doc/wiki)
## License ## License

6
README_CN.md
View File

@ -122,7 +122,11 @@ public class ApiDocTest {
![请求参数示例](https://images.gitee.com/uploads/images/2018/0905/172510_853735b9_144669.png "2.png") ![请求参数示例](https://images.gitee.com/uploads/images/2018/0905/172510_853735b9_144669.png "2.png")
#### 响应参数示例效果图 #### 响应参数示例效果图
![响应参数示例](https://images.gitee.com/uploads/images/2018/0905/172538_1918820c_144669.png "3.png") ![响应参数示例](https://images.gitee.com/uploads/images/2018/0905/172538_1918820c_144669.png "3.png")
## Building
如果你需要自己构建，那可以使用下面命令，构建需要依赖Java 1.8。
```
mvn clean install
```
## Releases ## Releases
[发布记录](https://github.com/shalousun/smart-doc/blob/master/RELEASE_CN.md/) [发布记录](https://github.com/shalousun/smart-doc/blob/master/RELEASE_CN.md/)
## Other reference ## Other reference