读我档案(英文:Readme,台湾又称为“读我档案”),是随著软件发布的一种说明文件,里面通常包含有软件的描述或使用的注意事项。这种档案通常是纯文字文件,被命名为README.TXT、README.1ST或READ.ME等等,但也有RTFDOCMarkdown格式的读我档案。档名通常是以大写英文字母组成,这是因为大写字母比小写字母有著较小的ASCII码,因此在一些以ASCII顺序来排序档案名称的作业系统里,它会被列在档案列表的第一个。即使这些人没有关于读我档案的知识,这种档案的特殊命名方式也能够使任何人迅速发现。

cURL的自述文件

内容

读我档案的内容通常包含:

  • 设置指南
  • 安装指南
  • 操作指南
  • 档案列表(随著软件而发布的档案)
  • 版权声明
  • 软件作者的联络方法
  • 已知程序错误
  • 疑难排解
  • 致谢
  • 更新记录

通用介面说明

读我档案偶尔也会被用来形容一些提供资讯的档案,包含读我档案普遍的内容。在一些开放源码的程式,特别是以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.

参考

Wikiwand in your browser!

Seamless Wikipedia browsing. On steroids.

Every time you click a link to Wikipedia, Wiktionary or Wikiquote in your browser's search results, it will show the modern Wikiwand interface.

Wikiwand extension is a five stars, simple, with minimum permission required to keep your browsing private, safe and transparent.