玩转Github项目的Readme.md

ReadMe主要包括哪些部分的内容:

  1. 国际化

  2. 项目简介
    自述,对自己的项目进行简洁全面的概述,包括项目来源,项目主要内容,各个部分功能,项目完成主要针对的目标.
    1.1 项目名称、logo(没有logo就不写)
    1.2 这个开源项目是做什么的?
    1.3 这个项目是什么语言编写的?

  3. 功能特性
    建议:静态的页面的放截图,交互很复杂的建议放gif图。 如果功能比较多,建议每个功能一张效果图

  4. 项目基本结构
    这里主要介绍项目的各个组成部分,如果是框架,可以附带架构图解;如果是其他的,可以提供一些UML分析图,顺便分析一下源码也行的。

  5. 环境依赖

  6. 部署步骤

  7. 目录结构描述

  8. 版本内容更新

  9. 参考资料

  10. 声明

  11. 协议


  • 参考
  1. 开发工具总结(9)之开源项目的README文档的最全最规范写法
  2. 如何选择开源许可证?
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,845评论 25 708
  • 用两张图告诉你,为什么你的 App 会卡顿? - Android - 掘金 Cover 有什么料? 从这篇文章中你...
    hw1212阅读 12,834评论 2 59
  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    阳明AGI阅读 16,003评论 3 119
  • 这是一个旧日的故事,虽然没有轰轰烈烈,却充满了爱。2016年10月16日,是一个周末假期,我打算简单轻松的度过。 ...
    敏而好学_舒敏阅读 375评论 0 4
  • 不管活了多少年,回首人生總覺得自己有遺憾和後悔。或許有人會因為沒有得到什麼而後悔,而對我而言,沒有去嘗試去...
    落子无悔ss阅读 135评论 0 0