美文网首页
玩转Github项目的Readme.md

玩转Github项目的Readme.md

作者: 我愿化作一道辰光 | 来源:发表于2018-11-21 11:53 被阅读0次

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. 如何选择开源许可证？

相关文章

网友评论

      本文标题：玩转Github项目的Readme.md

      本文链接：https://www.haomeiwen.com/subject/ayiqqqtx.html

      延伸阅读

      深度阅读

      • 您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

      栏目导航

      热点阅读

      关于我们|服务条款|联系我们|玩转Github项目的Readme.md|投稿指南|网站地图|RSS订阅|排版工具|手机版

      提供经典美文摘抄,优美散文欣赏,现代诗歌精选,短篇小说,心情随笔,表白情书范文,故事会在线阅读欣赏

      Copyright © 2014-2023 Haomeiwen.com All Rights Reserved. 好美文阅读网 版权所有

      备案信息：桂公网安备 45052102000051号 · 桂ICP备13007215号-3

      本站所收录作品、热点评论等信息部分来源互联网，目的只是为了系统归纳学习和传递资讯

      所有作品版权归原创作者所有，与本站立场无关，如不慎侵犯了你的权益，请联系我们告知，我们将做删除处理！