开源项目README建议

国际化

Github是面向全球的一个开源网站,所以不要局限于中文文档,建议写一个英文的README,让来自全球的人都能更方便的了解你的项目。推荐写法,在REAMDE开头写上国际化引用地址

在这里插入图片描述

项目介绍

项目介绍主要包括项目图标,介绍,项目特点等

项目上面增加一些图标以提高可读性,推荐使用 Shields.io

在这里插入图片描述

icon及图片设计

这里推荐一个在线制作 Logo 的网站 Canva(https://www.canva.cn/)

效果演示

如果是一些自定义控件或者项目的演示效果的,基本都会放上演示效果图,可以是图片,也可以是gif图。
建议:静态的页面的放截图,交互很复杂的建议放gif图。

项目特点

项目特点这块,是每个项目最吸引人的地方,这里一定要把开源项目的优点尽量提现出来,如支持分布式,多线程安全,轻量等等…

集成方式

这块一定要简明,不管是使用maven或者greadle作为项目的包管理,一定要简明的标识出如何引用此项目

Pull Request

项目根目录新建一个 CONTRIBUTING 进行详细的说明并在 README 中添加其文件锚链接。对于一个开源项目如果有人愿意贡献request是最值得庆幸的了

作者信息

作者或者组织的联系方式,微信,邮箱,博客,微博,甚至支付宝转账二维码等

协议

如果引用了哪些开源技术,这里可以做一些鸣谢,表示对别人的尊重,其实也是一个引用声明,避免因为版权而引起不必要的纠纷。
项目协议可以参考下图,对应选择相应的开源协议
在这里插入图片描述

项目目录

在这里插入图片描述

一个漂亮的项目目录介绍相信也能更加使看到此项目的开发者 更加清晰项目的结构,这里推荐使用tree命令来快速生成 代替手敲

brew install tree (mas os 安装)

tree -I node_modules > tree.text(项目根目录执行)
tree -d (只处理文件夹)

展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 大白 设计师: CSDN官方博客
应支付0元
点击重新获取
扫码支付

支付成功即可阅读