standard-readme-spec

# Standard README 规范 > 来源：[Standard Readme](https://github.com/RichardLitt/standard-readme)，作者 Richard Litt 合规的 README 必须满足以下列出的所有要求。 > 注意：Standard Readme 专为开源库设计。尽管它 [历史上](README.md#background) 是为 Node 和 npm 项目制作的，但也适用于其他语言和包管理器的库。 **要求：** - 命名为 README（注意大小写），并根据其格式具有特定的扩展名（Markdown 为 `.md`，Org Mode 标记语法为 `.org`，HTML 为 `.html` 等）。 - 如果项目支持国际化（i18n），文件名必须相应命名：`README.de.md`，其中 `de` 是 BCP 47 语言标签。命名时，优先使用非区域性的语言子标签。如果只有一个 README 且语言不是英语，则允许在文本中使用其他语言而无需指定 BCP 标签：例如，如果没有其他语言的 `README.md`，则 `README.md` 可以是德语。当存在多种语言时，`README.md` 保留给英语使用。 - 必须是所选格式（Markdown、Org Mode、HTML 等）的有效文件。 - 各章节必须按以下给出的顺序出现。可选章节可以省略。 - 除非另有说明，否则章节必须具有下列标题。如果 README 是其他语言，标题必须翻译成该语言。 - 不得包含失效链接。 - 如果有代码示例，它们应与项目中其余代码采用相同的 lint 规则。 ## 目录 _注意：这仅是规范的导航指南，并不定义或强制要求任何符合规范文档的术语。_ - [章节](#sections) - [标题](#title) - [横幅](#banner) - [徽章](#badges) - [简短描述](#short-description) - [长描述](#long-description) - [目录](#table-of-contents-1) - [安全](#security) - [背景](#background) - [安装](#install) - [使用](#usage) - [额外章节](#extra-sections) - [API](#api) - [维护者](#maintainers) - [致谢](#thanks) - [贡献](#contributing) - [许可证](#license) - [定义](#definitions) ## 章节 ### 标题 **状态：** 必需。 **要求：** - 标题必须与仓库、文件夹和包管理器的名称匹配 - 或者它可以有另一个相关的标题，并在其旁边附带仓库、文件夹和包管理器的标题。