Contents

1. 1. GitHub项目易读的 README.md
2. 2. 项目名称
   1. 2.0.1. 示例:
3. 2.1. 特性（可选）
4. 2.2. 原理说明（可选）
5. 2.3. 下载安装
6. 2.4. 使用方法
7. 2.5. 注意事项
8. 2.6. TODO（可选）

3. License

GitHub项目易读的 README.md

Github项目README.md模板
README作为说明文件，作用是让浏览者快速、鸟瞰式地了解项目。
为了做到这点，写README的时候应该注意层次和格式，用Markdown书写为佳。
一般至少包含三大部分，第一是介绍项目背景和用处，第二是使用方法（包括导入/安装，暴露的调用接口等），第三遵守的协议。

具体可以参照这份模板，模板本身已放到Github。

---

项目名称

---

关于我，欢迎关注
博客：
微信：
(如果你想打造个人品牌，把自己的介绍放在这里也是可以的)

Github项目README.md模板
（项目背景/作用介绍）

示例:

把使用了该项目的案例放在这里。可以放APK下载链接，或者简单放几张截图。
（示例一开始就放出来，方便浏览者一眼就看出是不是想找的东西）

特性（可选）

• 特性A

• 特性B

原理说明（可选）

阐述项目是基于什么思路设计的

下载安装

Gradle:

compile 'xxx'

(说明项目的配置方法，android开源库多用Gradle导入)

使用方法

怎么使用，有哪些步骤哪些接口。

注意事项

比如混淆方法等

TODO（可选）

接下来的开发/维护计划。

License

遵守的协议