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

  • 时间:
  • 浏览:1
  • 来源:uu快3和值_uu快3app_计划师

(十)贡献者/贡献组织

你你这个 主好多好多 引用了哪些开源技术,这里不会 做某些鸣谢,表示对别人的尊重,嘴笨 也是另一一两个多引用声明,处理机会版权而引起不前要的纠纷。

这里主要介绍项目的各个组成次责,机会是框架,不会 附带架构图解;机会是某些的,不会 提供某些UML分析图,顺便分析一下源码也行的。

英文版:

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

机会是某些自定义控件机会项目的演示效果的,基本有无上放演示效果图,不会 是图片,本来会 是gif图。

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

(一)国际化

比如 okhttp 有无 完全的3种集成依据:

版本不如可要,开源许可证不如可要,机会越来越生命版权,机会会机会某些侵权行为而无法很好的维权,版权信息不会 保护作者的权益(此人 理解)。

一般的README必不可少的,最重要的好多好多 用法,主要包括:安装,运行,编译,部署,debug,该github上的你你这个 库如可在此人 的项目中使用,以及前要注意的间题,版本更新适配间题等等。

中文版:

转载请标明出处:

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

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

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

效果图如下所示:

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

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

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

示相似下:

另一一两个多是下载Jar包;另一一两个多是引用Maven库;第另一一两个多是去掉 Gradle依赖:

比如 3300的RePlugin框架的特点就写的很完全:

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

(六)集成依据

(二)项目工程介绍

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

一般的项目传到jcenter里面机会AS插件传到jetbrains语录 一般会附带相关的集成依据的说明。(机会没哪些依据语录,你你这个 步不会 略过不看。)

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

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

(十二)版权信息

看过好多好多 有开源框架的README文档,综合一下,大约有以下几次责组成:

(十一)鸣谢

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

相似:我写的你你这个 库 https://github.com/AweiLoveAndroid/CommonDevKnowledge/blob/master/interview/summary.md 里面就写了鸣谢。

(四)项目特点

看过好多好多 有开源库,发现某些库的文档写的一团糟,有的甚至好多好多 另一一两个多标题,刚刚你此人 下载刚刚 运行,此人 摸索,看的很头疼。而哪些使用量大的库的文档写的很标准,很完全,看的很舒服。

(七)使用依据

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

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

你你这个 就很灵活了,有无 每另一一两个多必备,当然写出来方便亲戚朋友 联系作者,也是很好的。不会 写一下作者机会组织的联系依据,微信,邮箱,博客,微博,甚至支付宝转账二维码等有无 不会 上放去的。

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

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

README文档写的好语录能减少好多好多 有使用成本,能帮助你你这个 库让更多人了解,更多的人用,不会 说好的文档好多好多 另一一两个多门面。

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

(三) 项目的使用效果图

相似LitePal你你这个 开源库的混淆 如下图所示:

(八)混淆

相似 blankj的AndroidUtilCode你你这个 库为例,为了处理打广告嫌疑,我做了打码处理:

比如:

一般来说,开源库有无设置某些混淆规则的,次责项目机会项目类型特殊之处,好多好多 有就越来越混淆你你这个 项,具体的看开源项目来定。