Readme
外观
![本页使用了标题或全文手工转换](http://upload.wikimedia.org/wikipedia/commons/thumb/c/cd/Zh_conversion_icon_m.svg/35px-Zh_conversion_icon_m.svg.png)
此条目需要补充更多来源。 (2012年8月15日) |
![](http://upload.wikimedia.org/wikipedia/commons/thumb/1/1f/README-cURL.png/220px-README-cURL.png)
自述文件(英文:Readme,台湾又称为“读我档案”),是随着软件发布的一种帮助文档,里面通常包含有软件的描述或使用的注意事项。这种文件通常是纯文字文件,被命名为README.TXT、README.1ST或READ.ME等等,但也有RTF、DOC或Markdown格式的自述文件。文件名通常是以大写英文字母组成,这是因为大写字母比小写字母有着较小的ASCII码,因此在一些以ASCII顺序来排序文件名称的操作系统里,它会被列在文件列表的第一个。即使这些人没有关于自述文件的知识,这种文件的特殊命名方式也能够使任何人迅速发现。
内容
[编辑]自述文件的内容通常包含:
- 设置指南
- 安装指南
- 操作指南
- 文件列表(随着软件而发布的文件)
- 著作权声明
- 软件作者的联系方法
- 已知程序错误
- 疑难解答
- 致谢
- 更新记录
通用接口说明
[编辑]自述文件偶尔也会被用来形容一些提供信息的文件,包含自述文件普遍的内容。在一些开放源码的程序,特别是以GNU建置系统打包的文件里,通常会包含:
- README:一般信息
- AUTHORS:作者
- THANKS:致谢
- ChangeLog:更新记录,通常为程序管理员而设
- NEWS:更新记录,但专为用户而设
- INSTALL:安装指南
- COPYING:著作权声明
- BUGS:已知程序错误,亦包括回报错误的方法[1]
- FAQ:有关软件的问答[1]
- TODO:更新预告
额外阅读
[编辑]- Johnson, Mark. Building a Better ReadMe. Technical Communication (Society for Technical Communication). February 1997, 44 (1): p28–36. (原始内容存档于2013-11-04).
- Livingston, Brian. Check your Readme files to avoid common Windows problems. InfoWorld. 14 September 1998, 20 (37): p34.