最近要创建一个仓库分享自己的大论文程序和数据,就和平时上传代码一样,创建仓库以后按照默认的模板修改ReadMe文件。信息倒是展示的很全面,也有逻辑,但是美观度太差了。
好看的ReadMe和一般的ReadMe
首先对比一下两个不同的ReadMe文件:
- 更专业更美观

- 信息充足 美观不足

优化1:有自己的项目标志
多看几个Github上的项目,就会发现比较受欢迎的项目都会有自己的标志,标志不需要特别复杂或者有艺术性,但是一定要能体现项目的特点。
使用标志或者标志+标题的方式介绍自己的项目更加醒目一些。
优化2:加入不同的badges
加入badges可以为自己的项目贴上不同的标签,最常见的两个信息就是版本号和开源协议。
我也是刚开始了解budges,网上的介绍是
There are many badges that you can use in your README file to make it more visually appealing and informative.
虽然只是加了几个小小的标签,但是页面马上就会变得丰富起来,可能也是为了增加项目开发的仪式感吧。
优化3:XXXXX(探索中……)
我自己的修改后的ReadMe页面