README文档的规范写法总结

俗话说的好:“一个好开源项目一定有一个好的 README”。

要想自己放到github上的项目能吸引更多人的眼球,就必须写一个规范舒适的README.md,这么做不仅可以梳理自己对于项目的思路,也方便他人上手使用或学习。因此,此文根据Github上众多项目以及查阅相关资料对README做了一个小小的总结, 方便以后写README的时候可以直接套用该模板。


XXX系统(如果有Logo可以加上Logo)

xxx系统是一个..系统,支持…,…(此处为简要描述)

官方网站 | 文档手册 | 别的东西

目前,此系统包含有以下功能:

  • 功能1
  • 功能2
  • 功能3

准备

  • 依赖1
  • 依赖2
  • 依赖3

搭建环境

IntelliJ IDEA + MySQL 或者 eclipse + MySQL,…

快速开始

  • 步骤1
  • 步骤2
  • 步骤3

相关截图

截图1
截图2

To Do List

  • 功能1
  • 功能2
  • 功能3

CHANGE LOG

此处填写版本更新记录


至此,我们可以看到一个相对规范的README.md模板,在开源项目时可以直接套用该模板,而不必每次都采用不同的零零散散的格式去书写README。Markdown代码在下方给出,当然,大家也可以根据项目具体情况进行修改而使用。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
## XXX系统(如果有Logo可以加上Logo)
xxx系统是一个..系统,支持...,...(此处为简要描述)

[官方网站](http://example.com) | [文档手册](http://example.com) | [别的东西](http://example.com)

目前,此系统包含有以下功能:
* 功能1
* 功能2
* 功能3

### 准备
* 依赖1
* 依赖2
* 依赖3

### 搭建环境
IntelliJ IDEA + MySQL 或者 eclipse + MySQL,...

### 快速开始
* 步骤1
* 步骤2
* 步骤3

### 相关截图
截图1
截图2

### To Do List
* 功能1
* 功能2
* 功能3

### CHANGE LOG
此处填写版本更新记录

Contact

If you have some questions after you see this article, you can just find some info by clicking these links.