码迷,mamicode.com
首页 > 其他好文 > 详细

Github的readme的内容

时间:2019-11-23 22:20:01      阅读:116      评论:0      收藏:0      [点我收藏+]

标签:文件夹   模块   amp   strong   开发   链接   下载链接   项目   代码   

  1. [功能描述]:主要描述一下这个项目的主要功能列表。
  2. [开发环境]:罗列使用本工程项目所需要安装的开发环境及配置,以及所需软件的版本说明和对应的下载链接。
  3. [项目结构简介]:简单介绍项目模块结构目录树,对用户可以修改的文件做重点说明。
  4. [测试DEMO]:此处可以简单介绍一下DEMO程序的思路,具体实现代码放在example文件夹中。
  5. [作者列表]:对于多人合作的项目,可以在这里简单介绍并感谢所有参与开发的研发人员。
  6. [更新链接]:提供后续更新的代码链接。
  7. [历史版本]:对历史版本更改 记录做个简单的罗列,让用户直观的了解到哪些版本解决了哪些问题。
  8. [联系方式]:可以提供微信、邮箱等联系方式,其他人对这个工程不明白的地方可以通过该联系方式与你联系。

Github的readme的内容

标签:文件夹   模块   amp   strong   开发   链接   下载链接   项目   代码   

原文地址:https://www.cnblogs.com/zoey686/p/11919449.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!