请教我开源项目Readme文档的优化建议


#1

各位下午好,正好犯困的时候:sleeping: :sleeping:

刚写了一篇开源项目的readme,请大家帮忙看看,有什么需要优化修改的。

地址:

https://github.com/akaxincom/openzaly/blob/master/README.md

多谢:pray::pray:


#2

readme 这种事情,我觉得如果是自己的项目,想怎么写就怎么写,别人管不着!

就目前这个版本,建议 Logo 和 title 可以放在一行,不然开头的留白太多


#3

我是实用主义者,所以在把事情说清楚的前提之下,我觉得想怎么写怎么写


#4

按你平时浏览别的项目时的查看顺序来排吧

我一般是先看大到没法忽视的 项目名+Logo,然后是 系统/平台,适用的话就接着看 特性/简介, 不适用就直接关掉,一般般就加个书签然后关掉,觉得挺不错的就开始通读全文。

个人最喜欢的就是标题栏看门见山的,logo+项目+一句话简介,后面/下面再小字注明平台,特节省生命:

:chestnut: 栗子 :一种健康的零食


正文略


#5

建议不错,多谢