README规范

介绍

项目功能简述

快速开始

开发环境配置

• node / npm / yarn 版本
• nginx 配置
• 权限要求
• ...

开发

如何本地启动和调试项目

构建和发布

如何打包，组件发布方式，服务部署方式等

目录结构

- ...
  - ...

功能介绍

可以是链接或是直接展示

功能A

• 截图
• 说明
• ...

FAQ

问题A

回答A

更新日志

2022-05-27

• ...