【完善】IDE 介绍文档

Author: SummerGift

docs/MicroPythonPlug-in/README.md

@@ -2,17 +2,31 @@
 
 VSCode 最好用的 MicroPython 插件，为 MicroPython 开发提供了强大的开发环境，主要特性如下：
 
-- 支持通过网络连接远程调试
-- 支持网络、USB 或串口的方式连接开发板
-- 支持基于 MicroPython 的代码智能补全
+- 便捷的开发板连接方式
+- 支持基于 MicroPython 的代码智能补全与语法检查
 - 支持 MicroPython REPL 交互环境
-- 提供丰富的代码示例
-- 支持自动同步工程代码
-- 支持在设备上运行示例代码
-- 支持运行选中的代码片段
-- 支持多款 MicroPython 开发板
+- 提供丰富的代码示例与 demo 程序
+- 支持工程同步功能
+- 支持直接在设备上运行示例代码文件
+- 支持代码片段运行功能
+- 支持主流 MicroPython 开发板
 - 支持在 windows 以及 ubuntu 操作系统下运行
 
+## 开发板支持列表
+
+| 编号 | 开发板名称                                                   | 固件获取方式                                                 |
+| ---- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| 1    | [STM32L4 Pandora IoT Board](https://github.com/RT-Thread/IoT_Board/tree/master/examples/31_micropython) | [RT-Thread 论坛固件汇总贴](https://www.rt-thread.org/qa/forum.php?mod=viewthread&tid=12305&page=1&extra=#pid52954) |
+| 2    | [W601 IoT Board](https://github.com/RT-Thread/W601_IoT_Board/tree/master/examples/15_component_micropython) | [RT-Thread 论坛固件汇总贴 ](https://www.rt-thread.org/qa/forum.php?mod=viewthread&tid=12305&page=1&extra=#pid52954) |
+| 3    | [ESP8266](https://micropython.org/download#esp8266)          | 点击开发板名称链接获取                                       |
+| 4    | [ESP32](https://micropython.org/download#esp32)              | 点击开发板名称链接获取                                       |
+| 5    | [PYboard](https://micropython.org/download#pyboard)          | 点击开发板名称链接获取                                       |
+| 6    | [others](https://micropython.org/download#other)             | 点击开发板名称链接获取                                       |
+
+`STM32L4 Pandora IoT Board` 与 `W601 IoT Board` 开发板的固件由 RT-Thread 官方提供，同时针对 MicroPython 插件开发环境进行深度优化，提供强大的工程同步功能以及更加丰富的固件功能。
+
+欢迎加入RT-Thread MicroPython 交流 QQ 群 **703840633** 获取最新固件，进行技术交流。
+
 ## 准备工作
 
 1. 在 windows 操作系统下使用插件需要将 vscode 的默认终端修改为 powershell，如下图所示：
@@ -37,61 +51,41 @@ VSCode 最好用的 MicroPython 插件，为 MicroPython 开发提供了强大
 
 注意：配置修改后需要 **重启一下操作系统** 使配置生效。
 
-## 快速入门
+## 快速上手
+
+###  创建 MicroPython 工程
 
-### 创建一个 MicroPython 工程
+#### 创建一个空白 MicroPython 工程
 
 ![create_blank_dir](assets/create_blank_prj.gif)
 
+#### 创建一个基于demo 的 MicroPython 工程
+
 ![create_demo_dir](assets/create_demo_prj.gif)
 
 ### 连接开发板
 
-可以通过多种方式与开发板建立连接，现支持 USB 和网络连接方式。
-
-- 串口连接方式
-
 ![uart_connect](assets/uart_connect.gif)
 
-- USB 连接方式
-
-直接将开发板通过 USB 连接到 PC 机，将会自动通过 USB 连接设备，如下图所示：
-
-![usb_connect_device](assets/usb_connect.gif)
-
-- 网络连接方式
-
-点击连接按钮，然后选择想要连接的设备名称，如下图所示：
-
-![connect_device](assets/connect_device.gif)
-
-注意：第一次连接网络时请先用 USB 或者串口连接电脑，然后参考 network 例程进行网络连接。
-
 ### 运行示例代码
 
 和开发板建立连接后，可以直接运行示例代码，并观察代码在开发板上的运行效果，如下图所示：
 
 ![run_example](assets/run_example.gif)
 
-## 功能介绍
-
-- 通过网络、USB 或串口的方式连接开发板
-
-- 提供丰富的 MicroPython 代码示例程序
+### 丰富的 MicroPython 代码示例程序
 
 ![example_code](assets/example_code.png)
 
-- 支持在设备上直接运行示例代码
+### 在设备上直接运行示例代码文件
 
 ![run_example_code](assets/run_example_code.png)
 
-- 支持运行代码片段
+### 使用运行代码片段功能
 
 ![run_code_snippet](assets/run_code_snippet.gif)
 
-- 支持 STM32L4 Pandora IoT Board 、W601 IoT Board 等多款开发板
-- 优秀的代码编辑环境
-- 基于 MicroPython 的代码智能补全
+### 基于 MicroPython 的代码智能补全
 
 ![auto_complete](assets/auto_complete.gif)
 
@@ -103,16 +97,10 @@ VSCode 最好用的 MicroPython 插件，为 MicroPython 开发提供了强大
 - [RT-Thread MicroPython 论坛](https://www.rt-thread.org/qa/forum.php?mod=forumdisplay&fid=2&filter=typeid&typeid=20)
 - [MicroPython IDE 用户指南](https://www.rt-thread.org/document/site/submodules/micropython/docs/MicroPythonPlug-in/MicroPython_IDE_User_Manual/)
 - [MicroPython 固件开发指南](https://www.rt-thread.org/document/site/submodules/micropython/docs/MicroPythonPlug-in/MicroPython_Firmware_Development_Guide/)
-- RT-Thread MicroPython 交流 QQ 群：703840633
+- RT-Thread MicroPython 技术交流 QQ 群：703840633
 
 ## 注意事项
 
-- 请选择 PowerShell 作为默认终端
-
-在 PowerShell 终端中输入 `Set-ItemProperty HKCU:\Console VirtualTerminalLevel -Type DWORD 1` 可以解决退格键等显示乱码的问题。
-
-- 不要删除工程目录下的 `.mpyproject.json` 文件
-
-该文件是 MicroPython 工程的配置文件，删除后将无法正常运行 MicroPython 代码程序。
+- 不要删除工程目录下的 `.mpyproject.json` 文件，该文件是 MicroPython 工程的配置文件，删除后将无法正常运行 MicroPython 代码程序。