这是一个教你怎么写 README 的教程

引言

作为一个懒人,在有限的环境中,尽量的将一些重复性的活动能够自动化那是坠吼滴。

标题

  1. 一图胜千言

    使用: shields.io 标明项目的一些重要属性如:

    • 测试是否通过
    • 代码覆盖率
    • 使用的语言是什么
  2. 分割线

  3. 一句话介绍

目录

简单的使用相对路径将下面的目录结构写一下,一般放在最后写。

内容

没啥好说的。

License

证书 关于开源很多人有误解以为放在 github 上的开放 repo 就可以随便用了,其实不然,留意证书的类型,尊重作者的版权和辛勤劳动是很重要的。具体推荐看 http://www.ruanyifeng.com/blog/2011/05/how_to_choose_free_software_licenses.html了解。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
The MIT License (MIT)
Copyright (c) 2016 Alex Zhao
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.