Browse Source

Merge pull request #119 from SummerGGift/829

【完善】micropython 插件说明文档
朱天龙 (Armink) 6 năm trước cách đây
mục cha
commit
350596fba6

+ 7 - 11
docs/MicroPythonPlug-in/MicroPython_IDE_User_Manual.md

@@ -6,19 +6,15 @@ MicroPython 固件指的是可以运行在特定板卡上,并且已经对该
 
 
 ### 获取固件源码 
 ### 获取固件源码 
 
 
-MicroPython 固件源码可以从 RT-Thread 官方直接获取,自行编译下载即可。目前功能支持比较完备的是 IoT Board 潘多拉开发板,源代码地址如下:
+MicroPython 固件源码可以从 RT-Thread 官方直接获取,自行编译下载即可,目前功能支持比较完备的开发板列表如下:
 
 
-- Github 下载地址
+- IoT Board 潘多拉开发板
+    - [Github 仓库](https://github.com/RT-Thread/IoT_Board/tree/master/examples/31_micropython)
+    - [Gitee 仓库](https://gitee.com/Armink/IoT_Board/tree/master/examples/31_micropython) 
 
 
-```
-https://github.com/RT-Thread/IoT_Board/tree/master/examples/31_micropython
-```
-
-- Gitee 下载地址
-
-```
-https://gitee.com/Armink/IoT_Board
-```
+- W601 IoT Board 开发板
+    - [Github 仓库](https://github.com/RT-Thread/W601_IoT_Board/tree/master/examples/15_component_micropython)
+    - [Gitee 仓库](https://gitee.com/Armink/W601_IoT_Board/tree/master/examples/15_component_micropython) 
 
 
 ### 直接下载 bin 文件
 ### 直接下载 bin 文件
 
 

+ 21 - 2
docs/MicroPythonPlug-in/README.md

@@ -11,12 +11,13 @@ VSCode 最好用的 MicroPython 插件,为 MicroPython 开发提供了强大
 - 支持在设备上运行示例代码
 - 支持在设备上运行示例代码
 - 支持运行选中的代码片段
 - 支持运行选中的代码片段
 - 支持多款 MicroPython 开发板
 - 支持多款 MicroPython 开发板
+- 支持在 windows 以及 ubuntu 操作系统下运行
 
 
 ## 准备工作
 ## 准备工作
 
 
-如果想要使用 MicroPython 自动补全功能(如果暂时不需要自动补全功能,可以跳过这一步),需要安装依赖的 Microsoft Python 插件,准备工作如下:
+如果想要使用 MicroPython 自动补全功能(如果暂时不需要自动补全功能,可以跳过这一步),需要安装依赖的 Python 插件,准备工作如下:
 
 
-1. 安装 Microsoft Python 插件
+1. 安装 Python 插件
 
 
 2. 按照 Python 插件的提示在 PC 上安装 Python3 并加入到系统环境变量中
 2. 按照 Python 插件的提示在 PC 上安装 Python3 并加入到系统环境变量中
 
 
@@ -24,6 +25,14 @@ VSCode 最好用的 MicroPython 插件,为 MicroPython 开发提供了强大
 
 
 如果在 PC 上已经安装过上述插件和程序,可以跳过此准备步骤。
 如果在 PC 上已经安装过上述插件和程序,可以跳过此准备步骤。
 
 
+### ubuntu 支持
+
+本插件支持在 **ubuntu 18.04** 版本下运行,为了避免在 ubuntu 系统下频繁获取串口权限,需要将当前用户加入到 `dialout` 用户组中,手动输入如下命令即可,`$USERNAME` 是系统当前用户名:
+
+`sudo usermod -aG dialout $USERNAME`
+
+注意:配置修改后需要 **重启一下操作系统** 使配置生效。
+
 ## 快速入门
 ## 快速入门
 
 
 ### 创建一个 MicroPython 工程
 ### 创建一个 MicroPython 工程
@@ -80,6 +89,16 @@ VSCode 最好用的 MicroPython 插件,为 MicroPython 开发提供了强大
 
 
 ![auto_complete](assets/auto_complete.gif)
 ![auto_complete](assets/auto_complete.gif)
 
 
+## 开发资源
+
+- [RT-Thread MicroPython 开发用户手册](https://www.rt-thread.org/document/site/submodules/micropython/docs/)
+- [RT-Thread MicroPython 软件包](https://github.com/RT-Thread-packages/micropython)
+- [RT-Thread MicroPython 示例程序及库](https://github.com/RT-Thread/mpy-snippets)
+- [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
+
 ## 注意事项
 ## 注意事项
 
 
 - 请选择 PowerShell 作为默认终端
 - 请选择 PowerShell 作为默认终端

+ 11 - 7
docs/README.md

@@ -51,17 +51,20 @@
     - [手机遥控车](https://www.bilibili.com/video/av15008143?from=search&seid=16285206333541196172)
     - [手机遥控车](https://www.bilibili.com/video/av15008143?from=search&seid=16285206333541196172)
     - [搭建 MQTT 服务器](http://www.360doc.com/content/17/1218/22/8473307_714341237.shtml)
     - [搭建 MQTT 服务器](http://www.360doc.com/content/17/1218/22/8473307_714341237.shtml)
 
 
-## MicroPython 开发资源
+## RT-Thread MicroPython 开发资源
 
 
-- [RT-Thread MicroPython 开发手册](https://www.rt-thread.org/document/site/rtthread-development-guide/micropython/docs/README/)
-
-- [RT-Thread MicroPython 源码](https://github.com/RT-Thread-packages/micropython)
-
-- [RT-Thread MicroPython 论坛](https://www.rt-thread.org/qa/forum.php)
+- [RT-Thread MicroPython 开发用户手册](https://www.rt-thread.org/document/site/submodules/micropython/docs/)
+- [RT-Thread MicroPython IDE 用户指南](https://www.rt-thread.org/document/site/submodules/micropython/docs/MicroPythonPlug-in/MicroPython_IDE_User_Manual/)
+- [RT-Thread MicroPython 固件开发指南](https://www.rt-thread.org/document/site/submodules/micropython/docs/MicroPythonPlug-in/MicroPython_Firmware_Development_Guide/)
+- [RT-Thread MicroPython 软件包](https://github.com/RT-Thread-packages/micropython)
+- [RT-Thread MicroPython 示例程序及库](https://github.com/RT-Thread/mpy-snippets)
+- [RT-Thread MicroPython 论坛](https://www.rt-thread.org/qa/forum.php?mod=forumdisplay&fid=2&filter=typeid&typeid=20)
+- RT-Thread MicroPython 交流 QQ 群:703840633
 
 
+## MicroPython 官方资料
 - [MicroPython 官方网站](https://micropython.org/)
 - [MicroPython 官方网站](https://micropython.org/)
 
 
-- [官方在线文档](http://docs.micropython.org/en/latest/pyboard/)
+- [MicroPython 官方在线文档](http://docs.micropython.org/en/latest/pyboard/)
 
 
 - [MicroPython 在线演示](https://micropython.org/unicorn)
 - [MicroPython 在线演示](https://micropython.org/unicorn)
 
 
@@ -70,3 +73,4 @@
 - [MicroPython 官方论坛](http://forum.micropython.org/)
 - [MicroPython 官方论坛](http://forum.micropython.org/)
 
 
 - [MicroPython 中文社区](http://www.micropython.org.cn/)
 - [MicroPython 中文社区](http://www.micropython.org.cn/)
+