提示信息

项目说明文件 README.md 书写格式

风花雪月 已关注

项目名称:XXXXXXXXXXXXXXXXXXXXX

项目社区


目录

  1. 项目简介
  2. 项目使用效果图
  3. 安装说明
  4. 使用说明
  5. 项目架构
  6. 目录结构
  7. 关于作者/组织及交流方式等信息。
  8. 贡献者/贡献组织
  9. 鸣谢
  10. 版权信息
  11. 更新日志

项目简介

  • 项目定位
    描写项目定位信息

  • 项目特点
    描写项目特点

  • 软件功能
    描写项目软件功能

  • 版本信息
    描写版本信息

使用效果图

安装说明

  1. 环境依赖

部署安装

  1. 1. xxxxxxxxxxxxxxx
  2. 2. xxxxxxxxxxxxxxx
  3. 3. xxxxxxxxxxxxxxx
  4. 4. xxxxxxxxxxxxxxx

使用说明

  • 简要说明
  • 具体说明
  • 项目架构

    目录结构

    1. ├── Readme.md // help
    2. ├── app // 应用
    3. ├── config // 配置
    4. │ ├── default.json

    关于作者

    • 作者姓名:
    • 电话:
    • 邮箱:

    贡献者/贡献组织

    • 为该项目做出贡献的开发者

    鸣谢

    • 该项目参考了XXX的XXX
    • 灵感来源于XXX
    • 感谢XXX的支持和陪伴

    版权信息

    • 授权许可信息

    更新日志

    V1.0.0 版本,yyyy-mm-dd

    • 1、新功能:xxxxxxxxxxxxxxx
    • 2、新功能:xxxxxxxxxxxxxxx
    • 3、修改:xxxxxxxxxxxxxxx
    • 4、修复:xxxxxxxxxxxxxxx

    mycoding

    风花雪月 关注 已关注

    最近一次登录:2020-04-15 05:52:58   

    暂时还没有签名,请关注我或评论我的文章
    ×
    分享到朋友圈