Readme.txt对README.txt

Question

我刚刚在Github中分叉了一个项目，做了一些修改等等。这让我感到奇怪:我在开源项目中看到的大多是Readme.txt，而我编辑的文件是README.txt。这是某种标准，还是应该保持原样？

Answer 1

所有大写字母突出，使文件容易可见，这是有意义的，因为它可能是第一件事，一个新的用户会想要看。(或者至少应该看看…)正如其他人已经说过的，以大写字母开头的文件名将在ASCIIbetical排序(LC_COLLATE=C)中的小写名称之前列出，这有助于使文件乍一看可见。

README文件是免费软件包的用户通常希望找到的一堆文件的一部分。其他包括INSTALL (构建和安装软件的说明)、AUTHORS (贡献者列表)、COPYING (许可文本)、HACKING (如何开始进行贡献，可能包括TODO列表的起点)、NEWS (最近的更改)或ChangeLog (与版本控制系统大多是冗余的)。

这就是GNU编码标准对README文件的看法。

发行版应该包含一个名为README的文件，并对包进行总体概述：

• 包裹的名称；
• 软件包的版本号，或参考在包中可以找到版本的位置；
• 对包装所做工作的一般描述；
• 对文件INSTALL的引用，该文件应包含对安装过程的解释；
• 一个简短的解释，任何不寻常的顶级目录或文件，或其他提示，让读者找到他们的方式周围的来源；
• 对包含复制条件的文件的引用。如果使用GPL，应该在一个名为COPYING的文件中。如果使用GNU，它应该在一个名为COPYING.LESSER的文件中。

因为争取用户的最小惊喜总是很好的，所以您应该遵循这个约定，除非有令人信服的偏离原因。在UNIX世界中，文件扩展名传统上很少使用，因此文件的规范名称是README，没有任何后缀。但是，大多数用户可能不难理解一个名为README.txt的文件具有相同的含义。如果文件是用降价编写的，那么像README.md这样的文件名也可能是合理的。但是，避免在README文件中使用更复杂的标记语言(如HTML )，因为在纯文本终端上阅读应该很方便。您可以向用户指出该软件的手册或其在线文档，这些文档可能以更复杂的格式编写，以获得README文件中的详细信息。

Answer 2

传统上，该文件被大写为自述，因为使用字母排序的命令行环境会将文件放在顶部。这使得它们很容易在大目录中可见。

这很可能是Unix/Linux世界中的一个坚持，您可以在那里下载源代码，然后构建您的软件。拥有像README这样的文件并安装在“列表目录内容”视图的顶部，可以更容易地看到它们的存在，而不必从命令行界面浏览整个内容。同样的基本原则也适用于github (实际上也适用于GUI界面，因此它可能仍然有价值)。

这绝不是一条硬性规定，但很可能是每个人都习惯做的事情，因为其他项目都在这样做。除非有明确的理由不这样做，否则您可能应该使用所有的上限，因为您将看到它在许多其他项目中被这样使用。在创建新的存储库时，它也是默认的命名方式。

Answer 3

自述文件通常是用大写的。通过这种方式，ls Unix命令将文件放置在目录列表开头附近(大写字母在小写字母之前，按ASCII顺序排列)。