1. 1. README.md Sample
  • 项目名称
    1. 0.0.1. 示例:
  • 0.1. 更新日志
  • 0.2. 特性(可选)
  • 0.3. 原理说明(可选)
  • 0.4. 下载安装
  • 0.5. 使用方法
  • 0.6. 注意事项
  • 0.7. TODO(可选)
  • 1. License
  • README.md Sample

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

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


    项目名称


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

    Github项目README.md模板
    (项目背景/作用介绍)

    示例:

    把使用了该项目的案例放在这里。可以放APK下载链接,或者简单放几张截图。
    如果项目是个上架的App,直接把各应用市场(应用宝、小米应用市场、360应用市场、android play)的对应下载链接放上来。
    (示例一开始就放出来,方便浏览者一眼就看出是不是想找的东西)

    更新日志

    每次正式发布的版本信息及更新说明。

    特性(可选)

    • 特性A

    • 特性B

    原理说明(可选)

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

    下载安装

    Gradle:

    1
    compile 'xxx'

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

    使用方法

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

    注意事项

    比如混淆方法等

    TODO(可选)

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

    License

    遵守的协议