一个合格的开源项目 README 应该怎么写？

[Septembers]

[pupboss]

一定记得加 license😂不然你下个问题标题就是 《如何看待有人原封不动抄我源码？》

[adjusted]

LICENSE可以放到repo里面

[tencoldays]

可以参考我的: https://github.com/emqtt/emqttd。段落合理，清晰简洁，哈哈...

[lincanbin]

简介（Features）
如果是GUI相关一般还有带上一些Screenshot

环境要求（Requirements）


安装/部署（Installation）
一般整站开源会带有部署说明。

使用（Usage）
如果是一个开源库，一般来说除了仓库里的Demo外，ReadMe中还会有一段实例代码。


协议（License）

[lincanbin]

https://github.com/lincanbin/Carbon-Forum

https://github.com/lincanbin/Material-Design-Avatars

顺便发两个我自己写的ReadMe，前者是一个整站，后者是一个库。

[hoogle]

还有 CI status 什么的

[KexyBiscuit]

How to compile, 对新手很重要……好吧我是新手。