代码改变世界

随笔档案-2012年06月

如何编写合格的项目说明[ReadMe]文档?

2012-06-20 12:06 by chenkai, 15688 阅读, 收藏, 编辑
摘要: 昨天有一位同学在微博上问我关于GitHub 上为何Build 一个New Repository GitHub文件目录结构中为何总是存在Read ME.rb格式的文件? 如下: 其实如果当你打包或是开源协议授权方式分发你的Source Code.在构建完整项目结构的根目录下应该有一个名为ReadMe的文件来说明当前版本源码结构或版本信息.如果你常看开源项目也会发现一个规律.在你拿到一个源码解压后第一件事就是找对该Project的ReadMe文件阅读. Read Me文件的意义在于说明Source Code 做了什么? 运行在什么样环境下? 如何查看编辑代码? 其目的在于向使用者说明源码有... 阅读全文
无觅相关文章插件,快速提升流量
点击右上角即可分享
微信分享提示