一个合格的ReadMe文档应该包含的信息
首页 > Learning > Programming   作者:eehello  2016年3月21日 9:49 星期一  浏览:4632  字号:   评论:1 条
时间:2016-3-21 9:49   浏览:4632  评论:1 条 

一个合格的ReadMe文档应该包含的信息


  1. 整个项目的介绍[说明创建项目意图或是解决问题等]。

  2. 指出开发者编译整个项目需要的系统环境参数.并指出项目可能潜在的移植性问题。

  3. 当前项目中重要的文件和子目录的结构信息。[必须]

  4. 项目更多资源支持站点或是版本更新包获取所在的URL地址。

  5. 编译或安装步骤说明.或是指明这些信息所在的文件名。

  6. 关于本项目的版本更新或当前项目进展等信息。

  7. FAQ:以纯文本格式关于项目常见问题的解答。



 您阅读这篇文章共花了: 
 本文没有标签!
二维码加载中...
本文作者:eehello      文章标题: 一个合格的ReadMe文档应该包含的信息
本文地址:https://www.eehello.com/?post=204
版权声明:若无注明,本文皆为“点滴记忆---观雨亭”原创,转载请保留文章出处。
ee2016-04-14 13:47
python转windows的exe程序的软件下载地址:
https://sourceforge.net/projects/cx-freeze/files/4.3.3/

返回顶部| 首页| 手气不错| 留言板|后花园

Copyright © 2014-2023 点滴记忆---观雨亭