开发工具总结(9)之开源项目的README文档的最全最规范写法

  • 时间:
  • 浏览:2
  • 来源:UU快3—全天最准大发快三

(十二)版权信息

就看全都开源库,发现一点库的文档写的一团糟,有的甚至就说 一一兩个多标题,让他自己下载时候运行,自己摸索,看的很头疼。而哪些地方地方使用量大的库的文档写的很标准,很删改,看的很舒服。

(一)国际化

这里就拿 Glide 举例说明,Glide后面 一一兩个多多删改的wiki使用文档的,首页的README后面 也写了一一兩个多简单的基本用法,如下图所示:

比如 Picasso 后面 的版权信息,如下图所示:

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

README文档写的好一句话能减少全都使用成本,能帮助你这种库让更多人了解,更多的人用,都还上能说好的文档就说 一一兩个多门面。

有好的 README 文档的项目不一定是一一兩个多好开源项目,但一一兩个多好开源项目一定一一兩个多多好的 README。

(十一)鸣谢

中文版:

(七)使用法子

版本不得劲要,开源许可证不得劲要,肯能这麼生命版权,肯能会肯能一点侵权行为而无法很好的维权,版权信息都还上能保护作者的权益(自己理解)。

转载请标明出处:

https://www.jianshu.com/p/813b70d5b0de 本文出自 AWeiLoveAndroid的博客

比如 330的RePlugin架构图解 如下所示:

就看全都开源框架的README文档,综合一下,大概有以下几每段组成:

比如 okhttp 都有删改的3种集成法子:

一一兩个多是下载Jar包;一一兩个多是引用Maven库;第一一兩个多是再加Gradle依赖:

比如 330的RePlugin框架的特点就写的很删改:

一般的项目传到jcenter后面 肯能AS插件传到jetbrains一句话 一般会附带相关的集成法子的说明。(肯能没哪些地方地方地方法子一句话,你这种步都还上能略过不看。)

版权声明:本文为博主原创文章,未经博主允许不得转载。https://www.jianshu.com/p/813b70d5b0de

LoveHeartView使用示意图如下图所示:

(二)项目工程介绍

类式:我写的你这种库 https://github.com/AweiLoveAndroid/CommonDevKnowledge/blob/master/interview/summary.md 后面 就写了鸣谢。

效果图如下所示:

(五)项目的基本行态(架构)

(九)关于作者/组织及交流法子等信息。

(八)混淆

(三) 项目的使用效果图

英文版:

世界上的开源许可证,大概有上百种。很少人们搞得清楚它们的区别。最流行的有六种:GPL、BSD、MIT、Mozilla、Apache、LGPL

比如 谷歌推出的 sample 后面 都有贡献者/贡献组织信息,如下图所示:

项目介绍是必不可少的,它能让别人快速了解项目。项目介绍主要包括:

类式LitePal你这种开源库的混淆 如下图所示:

(十)贡献者/贡献组织

你这种主就说 引用了哪些地方开源技术,这里都还上能做一点鸣谢,表示对别人的尊重,确实也是一一兩个多引用声明,外理肯能版权而引起不让须的纠纷。

一般的README必不可少的,最重要的就说 用法,主要包括:安装,运行,编译,部署,debug,该github上的你这种库何如在自己的项目中使用,以及必须注意的问提,版本更新适配问提等等。

你这种就很灵活了,都有每一一兩个多必备,当然写出来方便大伙儿儿联系作者,也是很好的。都还上能写一下作者肯能组织的联系法子,微信,邮箱,博客,微博,甚至支付宝转账二维码等都有都还上能放满去的。

主就说 介绍项目的特点,方便别人查看和了解该项目。

(四)项目特点

肯能是一点自定义控件肯能项目的演示效果的,基本一定会放满演示效果图,都还上能是图片,都还上能能是gif图。

建议:静态的页面的放截图,交互很复杂的建议放gif图。 肯能功能比较多,建议每个功能一张效果图。

这里主要介绍项目的各个组成每段,肯能是框架,都还上能附带架构图解;肯能是一点的,都还上能提供一点UML分析图,顺便分析一下源码也行的。

比如:

示类式下:

下面就简单的总结一下README文档规范写法。(这就说 我自己根据github上几百个大型开源库总结出来的,如你有更好的意见,欢迎留言。)

https://github.com/AweiLoveAndroid/CommonDevKnowledge后面 的鸣谢

乌克兰多线程池池 员Paul Bagwell,画了一张分析图,说明应该缘何选取。这是我见过的最简单的讲解,只用两分钟,你就能搞清楚这 六种许可证之间的最大区别。

(六)集成法子

类式 blankj的AndroidUtilCode你这种库为例,为了外理打广告嫌疑,我做了打码外理:

一般来说,开源库一定会设置一点混淆规则的,每段项目肯能项目类型特殊之处,全都就这麼混淆你这种项,具体的看开源项目来定。