前言
当我们编写了一个NuGet包后,NuGet包的说明会非常重要
我们以之前IX.RCL.Front 这个项目为例
![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/9e630deb6db84692b7d63d5e9f5eb3a3.png)
1.添加Readme.md
在项目根目录 添加 Readme.md
文件属性中 生成操作 修改为:内容
![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/4ffb0c23e8974d36826eee065a565788.png)
2. 在Readme.md中添加 我们想给使用者 的提示
![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/6de73d0ec2604511bb65549f23fd618b.png)
3.生成一个新版本的包
![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/1ac3641d986e49e891b0e03a181fc9b3.png)
4.从NuGet包服务器更新刚才生成的包
![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/340b0c1a208f4d68bdf30bbf31986247.png)
5. 查看更新Nuget包后的Readme.md
我们看到 下载的NuGet包 已经有了 Readme.md
Readme.md会 跟随程序NuGet包一起下载
通常帮助文档 和 说明 写在 Readme.md 中 传递给使用者
![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/4cf1c0ffa1c94af2b9e46a8cb54d530f.png)