##README.md Sample Github项目README.md模板 README作为说明文件,作用是让浏览者快速、鸟瞰式地了解项目。 为了做到这点,写README的时候应该注意层次和格式,用Markdown书写为佳。 一般至少包含三大部分,第一是介绍项目背景和用处,第二是使用方法(包括导入/安装,暴露的调用接口等),第三遵守的协议。 PS(貌似咱们菜鸟不用写的这么高端=。=) 具体可以参照这份模板,模板本身已放到Github。
人员:lixinyi,lxy,wxm,lhz,sh ##Github地址https://github.com/Tanelmer/HisUncle ##demo地址http://webcafe.pub/ife/stage1/ ##Github项目README.md模板
- 以下这些我们都没有,菜鸟正在学习中,并不是很会玩。
- git 学习https://segmentfault.com/a/1190000000738398
- (项目背景/作用介绍)
####示例:
把使用了该项目的案例放在这里。可以放APK下载链接,或者简单放几张截图。
(示例一开始就放出来,方便浏览者一眼就看出是不是想找的东西)
###特性(可选)
-
特性A
-
特性B
###原理说明(可选) 阐述项目是基于什么思路设计的
Gradle:
compile 'xxx'
(说明项目的配置方法,android开源库多用Gradle导入)
###使用方法 怎么使用,有哪些步骤哪些接口。
比如混淆方法等
###TODO(可选) 接下来的开发/维护计划。
遵守的协议
忽略文件