Skip to content

Commit 701e8b3

Browse files
authored
Merge pull request #147 from SummerLife/update_micropython_docs
[optimize] micropython docs
2 parents f0e29e5 + 9e3f558 commit 701e8b3

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
## 1、介绍
44

5-
这是一个在 RT-Thread 上的 `MicroPython` 移植,可以运行在 **RT-Thread 3.0** 版本以上。通过这个软件包可以在搭载了 RT-Thread 的嵌入式系统上运行 `MicroPython`
5+
这是一个在 RT-Thread 上的 `MicroPython` 移植,可以运行在 **RT-Thread 3.0** 版本以上。通过该软件包可以在搭载了 RT-Thread 的嵌入式系统上运行 `MicroPython`
6+
7+
如果是第一次接触 RT-Thread MicroPython,推荐你先通过 RT-Thread 官方支持的开发板来快速上手,这些开发板的固件功能完善并提供源代码,适合入门学习,官方支持开发板 [固件下载请点我](https://www.rt-thread.org/qa/forum.php?mod=viewthread&tid=12305&extra=page%3D1%26filter%3Dtypeid%26typeid%3D20)
68

79
### 1.1 目录结构
810

@@ -36,35 +38,34 @@ RT-Thread MicroPython 遵循 MIT 许可,详见 `LICENSE` 文件。
3638

3739
### 3.1 添加软件包到工程
3840

39-
在选中 `MicroPython package` 后,再次进行 `bsp` 编译时,它会被加入到 `bsp` 工程中进行编译。
41+
选中 `MicroPython package` 后,再次进行 `bsp` 编译时,它会被加入到 `bsp` 工程中进行编译。
42+
43+
* 固件开发可参考 [《MicroPython 固件开发指南》](./docs/firmware-develop.md)
44+
45+
* 查阅更多 MicroPython 说明文档请访问 [RT-Thread 文档中心](https://www.rt-thread.org/document/site/submodules/micropython/docs/introduction/)
4046

41-
* 快速入门可查看 [快速上手](./docs/01-Getting_Started_Guide.md) 说明文档。
42-
* 开发过程可参考 `docs` 目录下的开发文档或者查看 [RT-Thread 文档中心](https://www.rt-thread.org/document/site/) 中的 `MicroPython 开发手册`
4347

4448
### 3.2 使用 MicroPython IDE
4549

46-
[RT-Thread MicroPython IDE](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 为 MicroPython 提供了强大的开发环境,可以通过 VScode 应用商店直接查询下载,示例如下
50+
[RT-Thread MicroPython IDE](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 为 MicroPython 提供了强大的开发环境,可以通过 VScode 应用商店直接查询下载,示例如下所示
4751

4852
![08_direct_run_files](docs/assets/08_direct_run_files.gif)
4953

5054

51-
### 3.3 向 MicroPython 添加 C 函数
55+
### 3.3 向 MicroPython 添加 C 扩展
5256

53-
为了方便用户添加自己编写的 C 函数到 MicroPython 中被 Python 脚本调用,RT-Thread 提供了 [MicroPython C 绑定代码自动生成器](https://summerggift.github.io/Micropython-C-Generator/) 供大家使用。通过该工具,用户只需要简单几步,即可实现添加 C 绑定的功能,下图展示了自动生成的 C 代码的形式。
57+
为了方便用户添加自己编写的 C 函数到 MicroPython 中被 Python 脚本调用,RT-Thread 提供了 [MicroPython C 绑定代码自动生成器](https://summerlife.github.io/RT-MicroPython-Generator/) 供大家使用。通过该工具,用户只需要简单几步,即可实现 C 函数扩展,下图展示了自动生成的 C 代码的形式。
5458

5559
![08_direct_run_files](docs/assets/c-gen.png)
5660

5761
## 4、注意事项
5862

59-
- 需要使用 **RT-Thread 3.0** 以上版本
60-
-`menuconfig` 选项中选择 `Micropython``latest` 版本
61-
- 目前 `System Module` 下的 `ffi` 模块只支持 GCC 工具链,且需要在链接脚本中添加相关段信息
63+
- 需要使用 **RT-Thread 3.0** 以上版本
64+
-`menuconfig` 选项中选择 `Micropython``latest` 版本
65+
- 目前 `System Module` 下的 `ffi` 模块只支持 GCC 工具链,且需要在链接脚本中添加相关段信息
6266

6367
## 5、开发资源
6468

6569
* [RT-Thread MicroPython 论坛](https://www.rt-thread.org/qa/forum.php)
6670
* [RT-Thread MicroPython 文档中心](https://www.rt-thread.org/document/site/submodules/micropython/docs/introduction/)
67-
* [MicroPython C 绑定代码自动生成器](https://summerggift.github.io/Micropython-C-Generator/)
68-
* [RT-Thread MicroPython IDE](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython)
6971
* [点击加入 RT-Thread MicroPython 交流群](https://jq.qq.com/?_wv=1027&k=5EhyEjx)
70-

docs/external_c_modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
当使用原生 MicroPython 进行开发时,你可能会遇到这样一些限制,比如官方没有实现自己想要的功能,或者你觉得这些实现不符合自己的工作需求。此时,添加自己的 C 模块到 MicroPython 中是一个不错的选择,你可以按照自己的想法,设计适合自己的 Python 函数调用。
44

5-
为了帮助各位开发者快速添加 C 模块,RT-Thread 提供了相应的辅助工具 [C 绑定代码自动生成器](https://summerggift.github.io/Micropython-C-Generator/)。该工具可以帮助开发者自动生成 C 代码和 MicroPython 之间的接口层,开发者只需将 C 语言编写的功能代码添加到指定位置,MicroPython 即可直接调用该功能。
5+
为了帮助各位开发者快速添加 C 模块,RT-Thread 提供了相应的辅助工具 [C 绑定代码自动生成器](https://summerlife.github.io/RT-MicroPython-Generator/)。该工具可以帮助开发者自动生成 C 代码和 MicroPython 之间的接口层,开发者只需将 C 语言编写的功能代码添加到指定位置,MicroPython 即可直接调用该功能。
66

77
## Python 调用 C 函数的实现原理
88

0 commit comments

Comments
 (0)