Skip to content

Commit 101d08f

Browse files
yangjie11yangjie11
committed
【增加】增加英文 readme
1 parent cf48580 commit 101d08f

File tree

2 files changed

+110
-35
lines changed

2 files changed

+110
-35
lines changed

‎README.md‎

Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,73 @@
11
# MicroPython
22

3-
## 1、介绍
3+
[中文页](README_ZH.md) | English
44

5-
这是一个在 RT-Thread 上的 `MicroPython` 移植，可以运行在 **RT-Thread 3.0** 版本以上。通过该软件包可以在搭载了 RT-Thread 的嵌入式系统上运行 `MicroPython`。
5+
## 1. Introduction
66

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)。
7+
This is a port of `MicroPython` on RT-Thread, which can run on **RT-Thread 3.0** or higher. This software package can run `MicroPython` on embedded systems equipped with RT-Thread.
88

9-
### 1.1 目录结构
9+
If it is the first time to come into contact with RT-Thread MicroPython, it is recommended that you use RT-Thread officially supported development boards to get started quickly. These development boards have complete firmware functions and provide source code, suitable for introductory learning, and officially support development boards [firmware download Please click on me](https://www.rt-thread.org/qa/forum.php?mod=viewthread&tid=12305&extra=page%3D1%26filter%3Dtypeid%26typeid%3D20).
1010

11-
| 名称 | 说明 |
11+
### 1.1 Directory structure
12+
13+
| Name | Description |
1214
| ---- | ---- |
13-
| docs | 文档目录，包括入门指南和开发手册 |
14-
| drivers | MicroPython 源代码目录 |
15-
| extmod | MicroPython 源代码目录 |
16-
| lib | MicroPython 源代码目录 |
17-
| py | MicroPython 源代码目录 |
18-
| port | 移植代码目录 |
19-
| LICENSE | Micropython MIT 许可证 |
15+
| docs | Document directory, including getting started guide and development manual |
16+
| drivers | MicroPython source code directory |
17+
| extmod | MicroPython Source Code Directory |
18+
| lib | MicroPython source code directory |
19+
| py | MicroPython source code directory |
20+
| port | Porting code directory |
21+
| LICENSE | Micropython MIT License |
2022

21-
### 1.2 许可证
23+
### 1.2 License
2224

23-
RT-Thread MicroPython 遵循 MIT 许可，详见 `LICENSE` 文件。
25+
RT-Thread MicroPython follows the MIT license, see the `LICENSE` file for details.
2426

25-
### 1.3 依赖
27+
### 1.3 Dependency
2628

2729
- RT-Thread 3.0+
2830

29-
## 2、如何打开 RT-Thread MicroPython
31+
## 2. How to open RT-Thread MicroPython
3032

31-
使用 `MicroPython package` 需要在 RT-Thread 的包管理器中选择它，具体路径如下：
33+
To use `MicroPython package`, you need to select it in the RT-Thread package manager. The specific path is as follows:
3234

3335
![elect_micropytho](./docs/assets/select_micropython.png)
3436

35-
然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。
37+
Then let the RT-Thread package manager automatically update, or use the `pkgs --update` command to update the package to the BSP.
3638

37-
## 3、使用 RT-Thread MicroPython
39+
## 3. Use RT-Thread MicroPython
3840

39-
### 3.1 添加软件包到工程
41+
### 3.1 Add software package to project
4042

41-
选中 `MicroPython package` 后，再次进行 `bsp` 编译时，它会被加入到 `bsp` 工程中进行编译。
43+
After selecting `MicroPython package`, when compiling with `bsp` again, it will be added to the `bsp` project for compilation.
4244

43-
* 固件开发可参考 [《MicroPython 固件开发指南》](./docs/firmware-develop.md)
45+
* For firmware development, please refer to [《MicroPython Firmware Development Guide》](./docs/firmware-develop.md)
4446

45-
* 查阅更多 MicroPython 说明文档请访问 [RT-Thread 文档中心](https://www.rt-thread.org/document/site/submodules/micropython/docs/introduction/)
47+
* For more MicroPython documentation, please visit [RT-Thread Documentation Center](https://www.rt-thread.org/document/site/submodules/micropython/docs/introduction/)
4648

4749

48-
### 3.2 使用 MicroPython IDE
50+
### 3.2 Using MicroPython IDE
4951

50-
[RT-Thread MicroPython IDE](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 为 MicroPython 提供了强大的开发环境，可以通过 VScode 应用商店直接查询下载，示例如下所示：
52+
[RT-Thread MicroPython IDE](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) provides a powerful development environment for MicroPython, which can be directly searched and downloaded through the VScode application store. Examples are as follows:
5153

5254
![08_direct_run_files](docs/assets/08_direct_run_files.gif)
5355

5456

55-
### 3.3 向 MicroPython 添加 C 扩展
57+
### 3.3 Add C extension to MicroPython
5658

57-
为了方便用户添加自己编写的 C 函数到 MicroPython 中被 Python 脚本调用，RT-Thread 提供了 [MicroPython C 绑定代码自动生成器](https://summerlife.github.io/RT-MicroPython-Generator/) 供大家使用。通过该工具，用户只需要简单几步，即可实现 C 函数扩展，下图展示了自动生成的 C 代码的形式。
59+
In order to facilitate users to add their own C functions to MicroPython to be called by Python scripts, RT-Thread provides [MicroPython C binding code automatic generator](https://summerlife.github.io/RT-MicroPython-Generator/) For everyone to use. With this tool, users only need a few simple steps to achieve C function extension. The following figure shows the form of the automatically generated C code.
5860

5961
![08_direct_run_files](docs/assets/c-gen.png)
6062

61-
## 4、注意事项
63+
## 4. Matters needing attention
6264

63-
- 需要使用 **RT-Thread 3.0** 以上版本
64-
- 在 `menuconfig` 选项中选择 `Micropython` 的 `latest` 版本
65-
- 目前 `System Module` 下的 `ffi` 模块只支持 GCC 工具链，且需要在链接脚本中添加相关段信息
65+
- Need to use **RT-Thread 3.0** or above
66+
- Select the `latest` version of `Micropython` in the `menuconfig` option
67+
- Currently, the `ffi` module under `System Module` only supports GCC toolchain, and relevant information needs to be added to the link script
6668

67-
## 5、开发资源
69+
## 5. Development resources
6870

69-
* [RT-Thread MicroPython 论坛](https://www.rt-thread.org/qa/forum.php)
70-
* [RT-Thread MicroPython 文档中心](https://www.rt-thread.org/document/site/submodules/micropython/docs/introduction/)
71-
* [点击加入 RT-Thread MicroPython 交流群](https://jq.qq.com/?_wv=1027&k=5EhyEjx)
71+
* [RT-Thread MicroPython Forum](https://www.rt-thread.org/qa/forum.php)
72+
* [RT-Thread MicroPython Documentation Center](https://www.rt-thread.org/document/site/submodules/micropython/docs/introduction/)
73+
* [Click to join the RT-Thread MicroPython exchange group](https://jq.qq.com/?_wv=1027&k=5EhyEjx)

‎README_ZH.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# MicroPython
2+
3+
中文页 | [English](README.md)
4+
5+
## 1、介绍
6+
7+
这是一个在 RT-Thread 上的 `MicroPython` 移植，可以运行在 **RT-Thread 3.0** 版本以上。通过该软件包可以在搭载了 RT-Thread 的嵌入式系统上运行 `MicroPython`。
8+
9+
如果是第一次接触 RT-Thread MicroPython，推荐你先通过 RT-Thread 官方支持的开发板来快速上手，这些开发板的固件功能完善并提供源代码，适合入门学习，官方支持开发板 [固件下载请点我](https://www.rt-thread.org/qa/forum.php?mod=viewthread&tid=12305&extra=page%3D1%26filter%3Dtypeid%26typeid%3D20)。
10+
11+
### 1.1 目录结构
12+
13+
| 名称 | 说明 |
14+
| ---- | ---- |
15+
| docs | 文档目录，包括入门指南和开发手册 |
16+
| drivers | MicroPython 源代码目录 |
17+
| extmod | MicroPython 源代码目录 |
18+
| lib | MicroPython 源代码目录 |
19+
| py | MicroPython 源代码目录 |
20+
| port | 移植代码目录 |
21+
| LICENSE | Micropython MIT 许可证 |
22+
23+
### 1.2 许可证
24+
25+
RT-Thread MicroPython 遵循 MIT 许可，详见 `LICENSE` 文件。
26+
27+
### 1.3 依赖
28+
29+
- RT-Thread 3.0+
30+
31+
## 2、如何打开 RT-Thread MicroPython
32+
33+
使用 `MicroPython package` 需要在 RT-Thread 的包管理器中选择它，具体路径如下：
34+
35+
![elect_micropytho](./docs/assets/select_micropython.png)
36+
37+
然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。
38+
39+
## 3、使用 RT-Thread MicroPython
40+
41+
### 3.1 添加软件包到工程
42+
43+
选中 `MicroPython package` 后，再次进行 `bsp` 编译时，它会被加入到 `bsp` 工程中进行编译。
44+
45+
* 固件开发可参考 [《MicroPython 固件开发指南》](./docs/firmware-develop.md)
46+
47+
* 查阅更多 MicroPython 说明文档请访问 [RT-Thread 文档中心](https://www.rt-thread.org/document/site/submodules/micropython/docs/introduction/)
48+
49+
50+
### 3.2 使用 MicroPython IDE
51+
52+
[RT-Thread MicroPython IDE](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 为 MicroPython 提供了强大的开发环境，可以通过 VScode 应用商店直接查询下载，示例如下所示：
53+
54+
![08_direct_run_files](docs/assets/08_direct_run_files.gif)
55+
56+
57+
### 3.3 向 MicroPython 添加 C 扩展
58+
59+
为了方便用户添加自己编写的 C 函数到 MicroPython 中被 Python 脚本调用，RT-Thread 提供了 [MicroPython C 绑定代码自动生成器](https://summerlife.github.io/RT-MicroPython-Generator/) 供大家使用。通过该工具，用户只需要简单几步，即可实现 C 函数扩展，下图展示了自动生成的 C 代码的形式。
60+
61+
![08_direct_run_files](docs/assets/c-gen.png)
62+
63+
## 4、注意事项
64+
65+
- 需要使用 **RT-Thread 3.0** 以上版本
66+
- 在 `menuconfig` 选项中选择 `Micropython` 的 `latest` 版本
67+
- 目前 `System Module` 下的 `ffi` 模块只支持 GCC 工具链，且需要在链接脚本中添加相关段信息
68+
69+
## 5、开发资源
70+
71+
* [RT-Thread MicroPython 论坛](https://www.rt-thread.org/qa/forum.php)
72+
* [RT-Thread MicroPython 文档中心](https://www.rt-thread.org/document/site/submodules/micropython/docs/introduction/)
73+
* [点击加入 RT-Thread MicroPython 交流群](https://jq.qq.com/?_wv=1027&k=5EhyEjx)

0 commit comments

Comments
 (0)