ChineseREADME: 中文标准README

2023-05-06 03:32| 来源: 网络整理| 查看: 265

标准中文README

README 文件通常是代码的第一个入口点。它应该告诉别人如何安装它，以及如何使用它。标准化编写 README 的方式可简化创建和维护你的 README 。

目录背景安装用法相关项目（可选）主要项目负责人参与贡献方式贡献人员开源协议背景

因为现在 Github 上的中国程序员越来越多，但是 Github 还是以英文为主导，对某些英语能力较弱的中国人不友好。所以，我根据 @RichardLitt 主导的标准 README 项目 RichardLitt/standard-readme 编写了中文版的标准 README 。

安装

Github 上的 README 一般是用 Markdown 编写的，所以后缀名是 .md 。所以你需要一个 Markdown 编辑器，我个人推荐使用 Visual Studio Code 。

用法

你可以直接下载 README.md 文件或者用 git 克隆此工程。然后使用 Visual Studio Code 等 Markdown 编辑器打开 README.md 文件，然后根据 README.md 的标准格式套用到你自己项目的 README 中。

使用 Markdown 语法编辑 README 。

目录下的项是一个项目的 README 一般需要包含的内容。在背景项下，说明该项目的开发背景，简要概述一下整个项目。在安装项下，说明整个项目的安装方法，尽量详细一点，如果篇幅过大可以另用其他文档描述。在用法项下，说明该项目的使用方法，尽量详细，如果篇幅过大也可以另用其他文档进行描述。在相关项目项下写明与该项目相关的其他项目，如果没有，可以不写。在主要项目负责人项下，写明该项目由谁负责。在参与贡献方式项下，说明如何参与贡献该项目。在贡献人员项下，写明全部或者主要的贡献人员，以向他们表示感谢。在开源协议项下，写明该项目的开源协议。

除上述的之外，还可以根据自己的具体项目进行调整增添删减。也可以适当在 README 中加入徽章，例如本文件的开头的：

你可以在 shields 中自己创作。