Merge pull request #134 from SummerGGift/english_readme

【添加】micropython 插件英文说明文档

Author: armink

docs/MicroPythonPlug-in/README.md

@@ -1,4 +1,6 @@
-# VSCode 最好用的 MicroPython 插件
+# VSCode 最好用的 MicroPython 插件 
+
+## 介绍 ([English](#Introduction))
 
 VSCode 最好用的 MicroPython 插件，为 MicroPython 开发提供了强大的开发环境，主要特性如下：
 
@@ -119,4 +121,105 @@ MicroPython 插件提供丰富的示例代码，可在左侧活动栏中查看
 
 - 不要删除工程目录下的 `.mpyproject.json` 文件，该文件是 MicroPython 工程的配置文件，删除后将无法正常运行 MicroPython 代码程序。
 
-  
+---
+
+# The best MicroPython plug-in of vscode
+
+## Introduction
+
+RT-Thread MicroPython is the best micropython plug-in in VScode, which provides a powerful development environment for MicroPython development. The main features are as follows:
+
+- Convenient connection mode of development board (serial port, network, USB)
+- Support MicroPython-based code intelligent completion and syntax check
+- Support MicroPython REPL interactive environment
+- Provides many code samples and demo program
+- Support full project synchronization function
+- Support for running sample code files on devices
+- Supports code snippets to run functions
+- Supports several major MicroPython development boards
+- Support Windows and ubuntu operating systems
+
+## Development board support list
+
+| number | Name of development board                                    | Firmware acquisition                                         |
+| ------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| 1      | [潘多拉 IoT Board 物联网开发板 STM32L475](https://item.taobao.com/item.htm?spm=a1z10.5-c-s.w4002-18400369818.12.2ba47ea5PzJxZx&id=583843059625) | [RT-Thread 论坛固件汇总贴](https://www.rt-thread.org/qa/forum.php?mod=viewthread&tid=12305&page=1&extra=#pid52954) |
+| 2      | [正点原子 W601 WIFI 物联网开发板](https://item.taobao.com/item.htm?spm=a230r.1.14.13.7c5b4a9bS2LYUD&id=602233847745&ns=1&abbucket=17#detail) | [RT-Thread 论坛固件汇总贴](https://www.rt-thread.org/qa/forum.php?mod=viewthread&tid=12305&page=1&extra=#pid52954) |
+| 3      | [正点原子探索者 STM32F407 开发板](https://item.taobao.com/item.htm?spm=a1z10.5-c-s.w4002-18400369818.18.569779dc0A3gkT&id=41855882779) | [RT-Thread 论坛固件汇总贴](https://www.rt-thread.org/qa/forum.php?mod=viewthread&tid=12305&page=1&extra=#pid52954) |
+| 4      | [ESP8266](http://docs.micropython.org/en/latest/esp8266/quickref.html) | [Official download link](https://micropython.org/download#esp8266) |
+| 5      | [ESP32](http://docs.micropython.org/en/latest/esp32/quickref.html) | [Official download link](https://micropython.org/download#esp32) |
+| 6      | [PYboard](http://docs.micropython.org/en/latest/pyboard/quickref.html) | [Official download link](https://micropython.org/download#pyboard) |
+| 7      | [others](https://micropython.org/download#other)             | [Official download link](https://micropython.org/download#other) |
+
+The firmware for the development boards numbered 1, 2, and 3 is provided by rt-thread, and is also optimized for the MicroPython plug-in development environment to provide powerful engineering synchronization and richer firmware features. 
+
+## Preparation
+
+1. Using plug-in under the Windows operating system requires changing the default terminal of vscode to powershell, as shown below:
+
+   ![select_powershell](assets/en_select_powershell.gif)
+
+If you want to use the MicroPython autocompletion feature (you can skip the next step if you don't need autocompletion for now), you need to do the following:
+
+2. Install the Python plug-in
+
+3. Install Python3 on your PC and add it to the system environment variables as instructed by the Python plug-in
+
+   ![Python plug](assets/install_python_plug.png)
+
+If you already have the above plug-ins and programs installed on your PC, you can skip this preparation step.
+
+### Ubuntu support
+
+This plug-in supports running under **ubuntu 18.04**. In order to avoid frequent access to serial port permissions under ubuntu system, the current user needs to be added to the user group `dialout`. Manually enter the following command: `$USERNAME` is the current USERNAME of the system:
+
+`sudo usermod -ag dialout $USERNAME`
+
+Note: the configuration change requires **to restart the operating system** for the configuration to take effect.
+
+## Quick Start
+
+### Create a MicroPython project
+
+The first step in MicroPython development is to create a MicroPython project within which all subsequent operations must run. There are two ways to create a new MicroPython project, a blank project and a demo-based project, which are shown below.
+
+![create_blank_dir](assets/en_create_blank_project.gif)
+
+### Connecting development board
+
+You can connect to the MicroPython development board by clicking the connection button in the lower left corner and then selecting the device you want to connect to in the pop-up list of devices.
+
+![uart_connect](assets/en_connect_board.gif)
+
+### View the sample code file
+
+The MicroPython plug-in provides a wealth of sample code and library files to view in the left active bar.
+
+![example_code](assets/check_example.png)
+
+### Run the MicroPython file on the device
+
+After successful connection of the development board, right click on the sample code file, select 'download and run the MicroPython file' on the device from the menu, and the sample file can be downloaded to the development board and run, as shown below:
+
+![run_example](assets/en_run_example_files.gif)
+
+### Run MicroPython code snippets on the development board
+
+If you just want to debug a small amount of code without downloading files to the development board, you can use the **code snippet** function.You can run the selected code in the REPL environment by selecting the snippet you want to run in the editor, and then selecting the 'execute the selected MicroPython code' option on the device from the right-click menu.
+
+![run_code_snippet](assets/en_run_snippets.gif)
+
+### Intelligent code completion based on MicroPython
+
+This plug-in supports intelligent code completion and syntax checking based on MicroPython syntax, which is a powerful tool for developing MicroPython code.It allows developers to write functions while looking at API parameter hints, and it gives them a visual reminder that makes it easier to find errors in code.
+
+![auto_complete](assets/auto_complete.gif)
+
+## Matters needing attention
+
+- Do not delete the `.mpyproject.json` file in the project directory. This file is the configuration file of the MicroPython project.
+
+## Contact & Supports
+
+- [Github](https://github.com/SummerGGift/ampy)
+- Support Email : [email protected]