README一般书写方式

README样例

xxx项目

项目简要说明

技术栈

项目稍详细介绍，背景、内容、做什么

- xxx1
- xxx2
- xxx3

项目技术选型

- 核心框架：xxx
- 持久层框架：xxx
- 数据库连接池：xxx
- 任务调度组件：xxx
- 日志管理：xxx
- 文档管理：xxx
- 接口文档管理：swagger
- 注册配置中心：nacos/eureka
- 消息组件：xxx
- 全文检索：xxx
- 非关系型数据库：xxx

项目特点

- xxx1
- xxx2
- xxx3

整体架构

xxxxxxxxxxxxxxxxxx

也可以使用流程图表示

项目结构

father
	|—— child1	describe
	|—— child2	describe
	|—— child3	describe
	...
	|—— childn	describe
	  |—— child.child1	describe
      |—— child.child2	describe
      |—— child.child3	describe
      

软件需求

- xxx1：version
- xxx2：version
- xxx3：version
- xxx4：version

其他

本地部署

本地需要软件（版本），修改相关配置，以及其他相关信息

发版部署

发版部署说明
操作步骤
端口说明等等

等等