zoukankan      html  css  js  c++  java
  • Github的README的内容

    1. [功能描述]:主要描述一下这个项目的主要功能列表。
    2. [开发环境]:罗列使用本工程项目所需要安装的开发环境及配置,以及所需软件的版本说明和对应的下载链接。
    3. [项目结构简介]:简单介绍项目模块结构目录树,对用户可以修改的文件做重点说明。
    4. [测试DEMO]:此处可以简单介绍一下DEMO程序的思路,具体实现代码放在example文件夹中。
    5. [作者列表]:对于多人合作的项目,可以在这里简单介绍并感谢所有参与开发的研发人员。
    6. [更新链接]:提供后续更新的代码链接。
    7. [历史版本]:对历史版本更改 记录做个简单的罗列,让用户直观的了解到哪些版本解决了哪些问题。
    8. [联系方式]:可以提供微信、邮箱等联系方式,其他人对这个工程不明白的地方可以通过该联系方式与你联系。
  • 相关阅读:
    第一阶段冲刺总结
    读书笔记之梦断代码1
    第二次站立会议5
    第二次站立会议4
    第二次站立会议3
    第二次站立会议2
    Java学习
    项目冲刺第十天
    项目冲刺第九天
    项目冲刺第八天
  • 原文地址:https://www.cnblogs.com/smuzoey/p/11919449.html
Copyright © 2011-2022 走看看