参考博客:MarkDown的主要用法,方便大家写README文件
为什么要写README文件?
这个问题很简单,因为README的编写,过了很长时间后,你仍然知道你当初写了什么;因为README的编写,其他人看你的代码不需要那么费劲,你代码的质量就大大的提高。
所以说README应该简短,大家不要以为写这个很麻烦,这个东西能够节省你和别人的很多时间。
完整的README包括什么内容?
关于README的内容,这是我觉得是每个项目中都应该有的一个文件,目的是能简要的描述该项目的信息,让读者快速了解这个项目。
一,它需要说以下几个事项:
1
2
3
4
5
6
7
8
9
|
1
,软件定位,软件的基本功能
2
,运行代码的方法:安装环境,启动命令等
3
,简要的使用说明
4
,代码目录结构说明,更详细点可以说明软件的基本原理
5
,常见问题说明
|
二,它包括了一下内容:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
项目和所有子模块和库的名称(对于新用户,有时不同命名会导致混乱)
对所有项目,和所有子模块和库的描述
如何使用
5
-
line code(如果是一个库)
版权和许可信息(或阅读许可证)
抓取文档指令
安装、配置和运行程序的指导
抓取最新代码和构建它们的说明(或快速概述和「阅读 Install」)
作者列表或「Read AUTHORS」
提交bug,功能要求,提交补丁,加入邮件列表,得到通知,或加入用户或开发开发区群的介绍
其他联系信息(电子邮件地址,网站,公司名称,地址等)
一个简短的历史记录(更改,替换或者其他)
法律声明
|