【类 型】：docs

【主	题】：修改说明
【描	述】：
	[原因]：
	[过程]：
	[影响]：
【结	束】

# 类型 包含:
# feat：新功能（feature）
# fix：修补bug
# docs：文档（documentation）
# style： 格式（不影响代码运行的变动）
# refactor：重构（即不是新增功能，也不是修改bug的代码变动）
# test：增加测试
# chore：构建过程或辅助工具的变动

README.md

@@ -1,34 +1,116 @@
-机载控制端esp32程序
-
-主要功能：
-
-   控制钩子自动收放
-
-   和飞控通讯发送航线，转发飞控控制和状态
-
-   控制喇叭
-
-   根据mqtt指令直接控制摄像头
 
 
-物理连接：
+# 机载控制端esp32程序
 
-   wifi连接4G模块
+项目简单描述
 
-   TTL连接飞控
 
-   模拟输出连接喇叭
+ 本篇README.md面向飞行魔方授权开发者
 
-   内网udp连接摄像头推流服务器
+## 目录
 
-   CAN连接收放控制电机
+- [项目描述](#项目描述)
+  
+- [上手指南](#上手指南)
+  
+  - [开发前的配置要求](#开发前的配置要求)
+  - [安装步骤](#安装步骤)
+  
+- [文件目录说明](#文件目录说明)
 
-   PWM连接锁定舵机
+- [开发的架构](#开发的架构)
 
-   模拟连接称重传感器
+- [部署](#部署)
 
-   IO连接开关控制
+- [使用到的框架](#使用到的框架)
+
+  
+
+### 项目描述
+
+###### 主要功能：
+
+1. 控制钩子自动收放
+2. 和飞控通讯发送航线，转发飞控控制和状态
+3. 控制喇叭
+4. 根据mqtt指令直接控制摄像头
 
-   IO连接LED灯控制
    
-    
+
+###### 物理连接：
+
+1. wifi连接4G模块
+2. TTL连接飞控
+3. 模拟输出连接喇叭
+4. 内网udp连接摄像头推流服务器
+5. CAN连接收放控制电机
+6. PWM连接锁定舵机
+7. 模拟连接称重传感器
+8. IO连接开关控制
+9. IO连接LED灯控制
+
+
+
+### 上手指南
+
+使用vscode和PlatformIO插件开发
+
+
+
+###### 开发前的配置要求
+
+1. vscode
+2. PlatformIO插件
+
+###### **安装步骤**
+
+1. 
+2. 
+
+```sh
+git clone https://github.com/shaojintian/Best_README_template.git
+```
+
+### 文件目录说明
+eg:
+
+```
+filetree 
+├── ARCHITECTURE.md
+├── LICENSE.txt
+├── README.md
+├── /account/
+├── /bbs/
+├── /docs/
+│  ├── /rules/
+│  │  ├── backend.txt
+│  │  └── frontend.txt
+├── manage.py
+├── /oa/
+├── /static/
+├── /templates/
+├── useless.md
+└── /util/
+
+```
+
+
+
+
+
+### 开发的架构 
+
+请阅读[ARCHITECTURE.md](https://github.com/shaojintian/Best_README_template/blob/master/ARCHITECTURE.md) 查阅为该项目的架构。
+
+### 部署
+
+暂无
+
+### 使用到的框架
+
+- PlatformIO
+
+  
+
+
+