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 中加入徽章,例如本文件的开头的:
你可以在 shields 中自己创作。
暂无
提交 PR 申请,我会视情况通过。
感谢所有贡献的人。
MIT © Andy