Skip to content

Commit db1a6a6

Browse files
GuozhanxinGuozhanxin
committed
【完善】添加英文 README.原 README 移至 README_ZH.md
1 parent 2bd9926 commit db1a6a6

File tree

2 files changed

+152
-57
lines changed

2 files changed

+152
-57
lines changed

‎README.md‎

Lines changed: 48 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,93 @@
1-
## 简介
1+
## Introduction
22

3-
sdk-bsp-stm32h750-realthread-artpi 是 RT-Thread 团队对 ART-Pi 开发板所作的支持包，也可作为用户开发使用的软件SDK，让用户可以更简单方便的开发自己的应用程序。
3+
[中文页](README_ZH.md) | 英文页
44

5-
ART-Pi 是 RT-Thread 团队经过半年的精心准备，专门为嵌入式软件工程师、开源创客设计的一款极具扩展功能的 DIY 开源硬件。
5+
sdk-bsp-stm32h750-realthread-artpi is a support package made by the RT-Thread team for the ART-Pi development board. It can also be used as a software SDK for user development, allowing users to develop their own applications more easily and conveniently.
6+
7+
ART-Pi is a DIY open source hardware with extended functions specially designed for embedded software engineers and open source makers after half a year of careful preparation by the RT-Thread team.
68

79
<img src="documents/figures/board_large.png" alt="image-20201009181905422" style="zoom:50%;" />
810

9-
## 目录结构
11+
## Directory Structure
1012

1113
```
12-
$ sdk-bsp-stm32h750-realthread-artpi
14+
$ sdk-bsp-stm32h750-realthread-artpi
1315
├── README.md
1416
├── RealThread_STMH750-ART-Pi.yaml
1517
├── debug
1618
├── documents
1719
│ ├── coding_style_cn.md
18-
│ ├── RT-Thread 编程指南.pdf
19-
│ ├── UM5001-RT-Thread ART-Pi 快速上手.md
20-
│ ├── UM5002-RT-Thread ART-Pi 开发手册.md
21-
│ ├── UM5003-RT-Thread ART-Pi BT_WIFI 模块固件下载手册.md
22-
│ ├── UM5004-RT-Thread ART-Pi 代码贡献手册.md
2320
│ ├── board
2421
│ └── figures
2522
├── libraries
26-
│ ├── STM32H7xx_HAL
27-
│ ├── drivers
28-
│ ├── rt_ota_lib
29-
│ └── wlan_wiced_lib
23+
│ ├── STM32H7xx_HAL
24+
│ ├── drivers
25+
│ ├── rt_ota_lib
26+
│ └── wlan_wiced_lib
3027
├── projects
31-
│ ├── art_pi_blink_led
32-
│ ├── art_pi_bootloader
33-
│ ├── art_pi_factory
34-
│ ├── art_pi_wifi
35-
│ └── industry_io_gateway
28+
│ ├── art_pi_blink_led
29+
│ ├── art_pi_bootloader
30+
│ ├── art_pi_factory
31+
│ ├── art_pi_wifi
32+
│ └── industry_io_gateway
3633
├── rt-thread
3734
└── tools
3835
```
3936

40-
- RealThread_STMH750-ART-Pi.yaml
41-
描述 ART-Pi 的硬件信息
42-
- debug
43-
QSPI FLASH 下载算法等
44-
- documents
45-
图纸，文档，图片以及 datasheets 等
46-
- libraries
47-
STM32H7 固件库，通用外设驱动，rt_ota 固件库，wlan 固件库等
48-
- projects
49-
示例工程文件夹，包含出厂程序，网关程序等
50-
- rt-thread
51-
rt-thread 源码
52-
- tools
53-
wifi 固件，BT 固件，rbl 打包工具等
54-
## 使用
55-
56-
sdk-bsp-stm32h750-realthread-artpi 支持 RT-Thread Studio 和 MDK 开发
37+
-RealThread_STMH750-ART-Pi.yaml
38+
Describe the hardware information of ART-Pi
39+
-debug
40+
QSPI FLASH download algorithm, etc.
41+
-documents
42+
Drawings, documents, pictures and datasheets, etc.
43+
-libraries
44+
STM32H7 firmware library, general peripheral driver, rt_ota firmware library, wlan firmware library, etc.
45+
-projects
46+
Sample project folder, including factory program, gateway program, etc.
47+
-rt-thread
48+
rt-thread source code
49+
-tools
50+
wifi firmware, BT firmware, rbl packaging tool, etc.
51+
## Use
5752

58-
### RT-Thread Studio 开发
53+
sdk-bsp-stm32h750-realthread-artpi supports RT-Thread Studio and MDK development
5954

55+
### RT-Thread Studio development
6056

61-
1. 打开 RT-Thread Studio 的包管理器，安装 ART-PI SDK 资源包
6257

63-
<img src="documents/figures/sdk_manager.png" alt="sdk_manager" style="zoom: 67%;" />
58+
1. Open the package manager of RT-Thread Studio and install the ART-PI SDK resource package
6459

60+
<img src="documents/figures/sdk_manager.png" alt="sdk_manager" style="zoom: 67%;" />
6561

66-
2. 安装完成后，选择基于 BSP 创建工程即可
6762

63+
2. After the installation is complete, choose to create a project based on BSP
6864
<img src="documents\figures\creat_project.png" alt="image-20200926143024666" style="zoom:50%;" />
6965

70-
### MDK 开发
71-
1. 在 [ART-Pi SDK仓库](https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi) 下载 SDK
66+
### MDK Development
67+
1. Download the SDK in [ART-Pi SDK Warehouse](https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi)
7268

73-
2. 进入工程目录。如：sdk-bsp-stm32h750-realthread-artpi\projects\art_pi_blink_led
69+
2. Enter the project directory. Such as: sdk-bsp-stm32h750-realthread-artpi\projects\art_pi_blink_led
7470

75-
3. 以管理员权限打开 windows 命令行 ，执行 mklink 命令，分别为 `rt-thread` 及 `libraries` 文件创建符号链接
71+
3. Use [ENV](https://club.rt-thread.org/ask/question/5699.html) tool to execute the mklink command to create symbolic links for the `rt-thread` and `libraries` files respectively
7672

7773
```
7874
E:\project\sdk-bsp-stm32h750-realthread-artpi\projects\art_pi_blink_led>mklink /D rt-thread ..\..\rt-thread
79-
为 rt-thread <<===>> ..\..\rt-thread 创建的符号链接
75+
symbolic link created for rt-thread <<===>> ..\..\rt-thread
8076
8177
E:\project\sdk-bsp-stm32h750-realthread-artpi\projects>mklink /D libraries ..\..\libraries
82-
为 libraries <<===>> ..\..\libraries 创建的符号链接
78+
symbolic link created for libraries <<===>> ..\..\libraries
8379
8480
E:\project\sdk-bsp-stm32h750-realthread-artpi\projects>
8581
```
86-
4. 使用 [ENV](https://club.rt-thread.org/ask/question/5699.html) 工具执行 scons --target=mdk5 即可
82+
4. Use [ENV](https://club.rt-thread.org/ask/question/5699.html) tool to execute 'scons --target=mdk5'
8783

8884

89-
## ART-Pi 交流平台
90-
91-
ART-Pi 是一个开源创意硬件平台，期待有更多的小伙伴能一起发现更多的乐趣，在使用过程中若您有任何的想法和建议，建议您通过以下方式来联系到我们。
92-
93-
RT-Thread [社区论坛](https://club.rt-thread.org/)。
94-
95-
ART-Pi 官方交流 QQ 群(1016035998)。
85+
## ART-Pi Communication Platform
9686

97-
![qq_group](documents/figures/qq_group.png)
87+
ART-Pi is an open source creative hardware platform. We look forward to having more friends who can discover more fun together. If you have any ideas and suggestions during use, we suggest you contact us through the following methods.
9888

99-
## 贡献代码
89+
RT-Thread [Community Forum](https://club.rt-thread.org/).
10090

101-
如果您对 ART-Pi 感兴趣，并有一些好玩的项目愿意与大家分享，欢迎给我们贡献代码，您可以参考 [ART-Pi 代码贡献手册](https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi/blob/master/documents/UM5004-RT-Thread%20ART-Pi%20%E4%BB%A3%E7%A0%81%E8%B4%A1%E7%8C%AE%E6%89%8B%E5%86%8C.md) 。
91+
## Contributing code
10292

93+
If you are interested in ART-Pi and have some fun projects willing to share with you, welcome to contribute code to us, you can refer to [ART-Pi Code Contribution Manual](https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi/blob/master/documents/UM5004-RT-Thread%20ART-Pi%20%E4%BB%A3%E7%A0%81%E8%B4%A1%E7%8C%AE%E6%89%8B%E5%86%8C.md).

‎README_ZH.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
## 简介
2+
3+
中文页 | [英文页](README.md)
4+
5+
sdk-bsp-stm32h750-realthread-artpi 是 RT-Thread 团队对 ART-Pi 开发板所作的支持包，也可作为用户开发使用的软件SDK，让用户可以更简单方便的开发自己的应用程序。
6+
7+
ART-Pi 是 RT-Thread 团队经过半年的精心准备，专门为嵌入式软件工程师、开源创客设计的一款极具扩展功能的 DIY 开源硬件。
8+
9+
<img src="documents/figures/board_large.png" alt="image-20201009181905422" style="zoom:50%;" />
10+
11+
## 目录结构
12+
13+
```
14+
$ sdk-bsp-stm32h750-realthread-artpi
15+
├── README.md
16+
├── RealThread_STMH750-ART-Pi.yaml
17+
├── debug
18+
├── documents
19+
│ ├── coding_style_cn.md
20+
│ ├── RT-Thread 编程指南.pdf
21+
│ ├── UM5001-RT-Thread ART-Pi 快速上手.md
22+
│ ├── UM5002-RT-Thread ART-Pi 开发手册.md
23+
│ ├── UM5003-RT-Thread ART-Pi BT_WIFI 模块固件下载手册.md
24+
│ ├── UM5004-RT-Thread ART-Pi 代码贡献手册.md
25+
│ ├── board
26+
│ └── figures
27+
├── libraries
28+
│ ├── STM32H7xx_HAL
29+
│ ├── drivers
30+
│ ├── rt_ota_lib
31+
│ └── wlan_wiced_lib
32+
├── projects
33+
│ ├── art_pi_blink_led
34+
│ ├── art_pi_bootloader
35+
│ ├── art_pi_factory
36+
│ ├── art_pi_wifi
37+
│ └── industry_io_gateway
38+
├── rt-thread
39+
└── tools
40+
```
41+
42+
- RealThread_STMH750-ART-Pi.yaml
43+
描述 ART-Pi 的硬件信息
44+
- debug
45+
QSPI FLASH 下载算法等
46+
- documents
47+
图纸，文档，图片以及 datasheets 等
48+
- libraries
49+
STM32H7 固件库，通用外设驱动，rt_ota 固件库，wlan 固件库等
50+
- projects
51+
示例工程文件夹，包含出厂程序，网关程序等
52+
- rt-thread
53+
rt-thread 源码
54+
- tools
55+
wifi 固件，BT 固件，rbl 打包工具等
56+
## 使用
57+
58+
sdk-bsp-stm32h750-realthread-artpi 支持 RT-Thread Studio 和 MDK 开发
59+
60+
### RT-Thread Studio 开发
61+
62+
63+
1. 打开 RT-Thread Studio 的包管理器，安装 ART-PI SDK 资源包
64+
65+
<img src="documents/figures/sdk_manager.png" alt="sdk_manager" style="zoom: 67%;" />
66+
67+
68+
2. 安装完成后，选择基于 BSP 创建工程即可
69+
70+
<img src="documents\figures\creat_project.png" alt="image-20200926143024666" style="zoom:50%;" />
71+
72+
### MDK 开发
73+
1. 在 [ART-Pi SDK仓库](https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi) 下载 SDK
74+
75+
2. 进入工程目录。如：sdk-bsp-stm32h750-realthread-artpi\projects\art_pi_blink_led
76+
77+
3. 使用 [ENV](https://club.rt-thread.org/ask/question/5699.html) 工具执行 mklink 命令，分别为 `rt-thread` 及 `libraries` 文件创建符号链接
78+
79+
```
80+
E:\project\sdk-bsp-stm32h750-realthread-artpi\projects\art_pi_blink_led>mklink /D rt-thread ..\..\rt-thread
81+
symbolic link created for rt-thread <<===>> ..\..\rt-thread
82+
83+
E:\project\sdk-bsp-stm32h750-realthread-artpi\projects>mklink /D libraries ..\..\libraries
84+
symbolic link created for libraries <<===>> ..\..\libraries
85+
86+
E:\project\sdk-bsp-stm32h750-realthread-artpi\projects>
87+
```
88+
4. 使用 [ENV](https://club.rt-thread.org/ask/question/5699.html) 工具执行 scons --target=mdk5 即可更新 MDK5 工程文件
89+
90+
91+
## ART-Pi 交流平台
92+
93+
ART-Pi 是一个开源创意硬件平台，期待有更多的小伙伴能一起发现更多的乐趣，在使用过程中若您有任何的想法和建议，建议您通过以下方式来联系到我们。
94+
95+
RT-Thread [社区论坛](https://club.rt-thread.org/)。
96+
97+
ART-Pi 官方交流 QQ 群(1016035998)。
98+
99+
![qq_group](documents/figures/qq_group.png)
100+
101+
## 贡献代码
102+
103+
如果您对 ART-Pi 感兴趣，并有一些好玩的项目愿意与大家分享，欢迎给我们贡献代码，您可以参考 [ART-Pi 代码贡献手册](https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi/blob/master/documents/UM5004-RT-Thread%20ART-Pi%20%E4%BB%A3%E7%A0%81%E8%B4%A1%E7%8C%AE%E6%89%8B%E5%86%8C.md) 。
104+

0 commit comments

Comments
 (0)