【三】编写README.md

前言

现在项目已经有了，但是我们还没有正式的介绍我们的项目和添加 License 文件，这一章我们就一起来看看如何写一个README.md

内容

为了更好的写出好的一个 README.md，我们先看看优秀的开源项目都是怎么写的。

tdesign-vue-next：https://github.com/Tencent/tdesign-vue-next/blob/develop/README-zh_CN.md

Vue：https://github.com/vuejs/core

element：https://github.com/ElemeFE/element

Rust：https://github.com/rust-lang/rust

这里我们只列举三个项目，如果感兴趣的话，你可以查看更多优秀项目的 README.md 。好了，看过这三个项目后，我们大概知道一个项目的 README.md 需要包含哪些内容，接下来我们就来尝试写下自己项目的 README.md 。

语言

默认提供 英语 和 中文 的 README.md，这里我们也提供两个版本的 README.md，先将中文的写好，再进行翻译即可。

安装

基础的安装使用教程，这里我们还没开发完成，所以暂时留空即可。

开源协议

在最后的末尾来，描述下自己项目遵循的协议内容，License 我们可以在仓库创建的时候进行添加，如果前期没有添加的话，后续在 github 的仓库里去再添加也是可以的，直接添加LICENSE文件，然后选择对应的协议，确认好信息后，直接提交即可。

Logo

一个项目最起码要有个自己的脸面是不，不过是否需要一个Logo，可以根据自己的需求来定，毕竟现在生成Logod 的网站其实挺多的。

徽章

这里作为演示，我们就简单添加一些徽章，具体的各位可根据自身的喜好，到 shields 网站去生成，并添加到自己的项目中。

shields：https://shields.io/

徽章作为一个项目的点缀，这个必须拿下，接下来我们说下如何配置徽章。

GitHub Release

GitHub Release：https://shields.io/badges/git-hub-release

只需要输入 user 和 repo 即可得到一个版本的徽章，不过如果当前的仓库没有版本信息或者没有找到仓库地址，则会生成失败。

GitHub Release

node-current

node-current：https://shields.io/badges/node-current

只需要输入 packageName ，即可获取到软件包是否支持最新版本 node 的徽章，比如我们要获取 vite 对应的徽章，只需要在 packageName 输入 vite 即可。

Node Current

Github License

Github License：https://shields.io/badges/git-hub-license

只需要输入 user 和 repo ，即可获得当前仓库下的许可证信息。

GitHub License

效果

中文：https://github.com/oyo-cool/eaui/blob/main/README-zh_CN.md

英文（默认）：https://github.com/oyo-cool/eaui/blob/main/README.md

总结

这一章最主要的其实就是徽章的生成，毕竟以大家的聪明才智，写个 README.md 肯定是手到擒来。