Skip to main content

Readme 规范

 README.md 应包含以下章节:

项目名称

项目简介

功能特性

快速开始

环境要求

安装步骤

配置说明

本地开发

开发环境搭建

运行项目

调试方法

生产部署

部署前准备

部署步骤

环境变量配置

健康检查

API文档

测试

贡献指南