写README的基础

参考

• README的艺术 https://github.com/hackergrrl/art-of-readme/blob/master/README-zh.m
• 如何写好 README https://zhuanlan.zhihu.com/p/22900142
• 标准自述文件 https://github.com/RichardLitt/standard-readme/blob/master/README.md

项目名称

下面这个是徽章，是用来简单明了的展示实现原理和版本的


一句话描述项目

写项目的详细介绍，简洁，具体完成的功能：

• 项目和所有子模块和库的名称（对于新用户，有时不同命名会导致混乱）
• 对所有项目，和所有子模块和库的描述

目录

• 背景
• 安装
• 用法
• 徽章
• 示例文件
• 相关努力
• 维护者
• 贡献
• 许可证

background

• 介绍项目的背景

install

• 安装教程

usage

• 写如何操作使用及步骤，有代码贴代码

badge

• 表示版本、使用技术的徽章

example

• 代码或程序样例

related-efforts

• 介绍一些相关的努力和工作

maintainers

• 介绍维护者、以及对应维护的内容

contributing

• 介绍此项目的贡献者、及其贡献内容

license

• 许可证不太理解 看看这篇文章 https://zhuanlan.zhihu.com/p/111461655

某某单位 © xx

Change Log

• 写版本更新日志