Skip to content
This repository has been archived by the owner on Mar 23, 2021. It is now read-only.

Commit

Permalink
docs(readme): 优化
Browse files Browse the repository at this point in the history
  • Loading branch information
zjZSTU committed Sep 20, 2019
1 parent 6dada85 commit 9b865dc
Showing 1 changed file with 30 additions and 9 deletions.
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,47 @@
学习和使用容器和自动化工具

1. `Docker`
2. `Kubernetes`
3. `Jenkins CI`
4. `Travis CI`

## 内容列表

- [背景](#背景)
- [安装](#安装)
- [用法](#用法)
- [主要维护人员](#主要维护人员)
- [参与贡献方式](#参与贡献方式)
- [许可证](#许可证)

## 背景

容器以及自动化工具的出现极大的加快了软件的生产步骤,学习以下工具:
容器以及自动化工具的出现极大的加快了软件的生产步骤,同时能够有效解决复杂的依赖环境。看了Docker和CI工具的介绍,好好利用起来能得到一个很棒的开发环境,赶紧动起来!!!

1. `Docker`
2. `Kubernetes`
3. `Jenkins CI`
4. `Travis CI`
## 安装

需要预先安装以下工具:

```
$ pip install -U Sphinx
$ sudo apt-get install make
```

## 用法

参考[Containers and Automation](https://container-automation.readthedocs.io/zh_CN/latest/)教程
有两种使用方式

1. 在线浏览文档:[Containers and Automation](https://container-automation.readthedocs.io/zh_CN/latest/)

2. 本地生成文档,实现如下:

```
$ git clone https://github.com/zjZSTU/Containerization-Automation.git
$ cd Containerization-Automation/docs
$ make html
```
编译完成后进入`docs/build/html`目录,打开`index.html`文件

## 主要维护人员

Expand All @@ -37,9 +58,9 @@

注意:

* `git`提交请遵守[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
* 如果进行版本化,请遵守[Semantic Versioning 2.0.0](https://semver.org)规范
* 如果修改README,请遵守[standard-readme](https://github.com/RichardLitt/standard-readme)规范
* `GIT`提交,请遵守[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)规范
* 语义版本化,请遵守[Semantic Versioning 2.0.0](https://semver.org)规范
* `README`编写,请遵守[standard-readme](https://github.com/RichardLitt/standard-readme)规范

## 许可证

Expand Down

0 comments on commit 9b865dc

Please sign in to comment.