Android开源项目README规范

---

layout: post title: “Android开源项目README规范” date: 2017-8-23 20:40:54 updated: tags:

• Android
• GitHub categories: GitHub thumbnail:

---

Android开源项目README规范

下面以我自己的项目 MyGankio 为例，规范一下我的 README.md 的书写?

国际化问题

首先你最好提供中英两个版本。

README：英文 | 中文

• 这个开源项目是做什么的？
• 这个项目是什么语言编写的？
• 项目维护、CI、依赖更新状态（如果有）
• 项目可用版本及其他版本
• Demo 或官网地址（如果有)

我的MyGankio就可以这样写：

MyGankio is a mvp project simple use Rxjava,Retrofit and Glide. The project api is from Gank.io.

介绍简单明了就好。

此外可以给项目添加一些图标增加可读性。如使用Shields.io,例:-

-

当然这个图标不仅仅是为了好看而已，还可以通过 Cricle CI 等网站，把编译的信息同步上去。

一定不要忘记了使用给自己找一个合适的license:-

-

那么多license要选那个呢？

项目的Logo和截图

项目的获取方式

参考列表：

如何编写开源项目的 README 文档

几条小经验帮你美化你的GitHub开源项目

Shields.io —— 制作各种状态图标