Skip to content

Commit b543531

Browse files
authored
Merge pull request #107 from luhuadong/develop
【调整】强迫症调整文档格式
2 parents 23870ef + 95d14fb commit b543531

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

README.md

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

33
sdk-bsp-stm32h750-realthread-artpi 是 RT-Thread 团队对 ART-Pi 开发板所作的支持包,也可作为用户开发使用的软件SDK,让用户可以更简单方便的开发自己的应用程序。
44

5-
ART-Pi 是 RT-Thread 团队经过半年的精心准备,专门为嵌入式软件工程师、开源创客设计的一款极具扩展功能的 DIY 开源硬件.
5+
ART-Pi 是 RT-Thread 团队经过半年的精心准备,专门为嵌入式软件工程师、开源创客设计的一款极具扩展功能的 DIY 开源硬件
66

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

@@ -42,9 +42,9 @@ $ sdk-bsp-stm32h750-realthread-artpi
4242
- debug
4343
QSPI FLASH 下载算法等
4444
- documents
45-
图纸,文档,图片以及 datasheets等
45+
图纸,文档,图片以及 datasheets 等
4646
- libraries
47-
STM32H7固件库,通用外设驱动,rt_ota固件库,wlan固件库等
47+
STM32H7 固件库,通用外设驱动,rt_ota 固件库,wlan 固件库等
4848
- projects
4949
示例工程文件夹,包含出厂程序,网关程序等
5050
- rt-thread
@@ -58,12 +58,13 @@ sdk-bsp-stm32h750-realthread-artpi 支持 RT-Thread Studio 和 MDK 开发
5858
### RT-Thread Studio 开发
5959

6060

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

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

6565

66-
2. 安装完成后 选择基于 BSP 创建工程即可
66+
2. 安装完成后,选择基于 BSP 创建工程即可
67+
6768
<img src="documents\figures\creat_project.png" alt="image-20200926143024666" style="zoom:50%;" />
6869

6970
### MDK 开发

documents/UM5003-RT-Thread ART-Pi BT_WIFI 模块固件下载手册.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# ART-Pi BT_WiFi 模块固件下载
22

3-
ART-Pi 板卡在出厂时已经烧录过 BT_WiFi 固件,存储在外部 Flash。如果固件被
4-
不慎擦除,会导致 BT_WiFi 模组的功能无法正常使用,出现异常情况,需要重新烧录 BT_WiFi 固件。
5-
RT-Thread 提供的解决方式:先烧录出厂例程固件 `factory`,然后选择使用 Ymodem 下载固件。
3+
ART-Pi 板卡在出厂时已经烧录过 BT_WiFi 固件,存储在外部 Flash。如果固件被不慎擦除,会导致 BT_WiFi 模组的功能无法正常使用,出现异常情况,需要重新烧录 BT_WiFi 固件。RT-Thread 提供的解决方式:先烧录出厂例程固件 `factory`,然后选择使用 Ymodem 下载固件。
64

75
## 烧录出厂例程
86

@@ -15,4 +13,5 @@ wifi 和蓝牙固件的下载方式相同,可以通过终端进行 ymodem 传
1513
2. 使用 ymodem 进行文件传输。
1614

1715
完成后系统会自动识别传入的固件,若固件有效则会自动搬运到对应的固件存储区。
18-
![WIFI-OTA](./figures/wifi_ota.gif)
16+
17+
![WIFI-OTA](./figures/wifi_ota.gif)

documents/UM5004-RT-Thread ART-Pi 代码贡献手册.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@
4141
- 参考 art_pi_blink_led 例程,复制该例程,并更名为相关的例程文件夹名,例如:art_pi_wifi
4242

4343
### 2. 开发阶段
44-
1. 按照例程需求,编写例程代码,代码编写需符合《[RT-Thread 编程风格](coding_style_cn.md)》,Git提交日志信息描述清晰
45-
2. 软件代码尽可能的简洁,保证用户看到的代码清晰,容易理解。在menuconfig 中也不要开启无关选项
44+
1. 按照例程需求,编写例程代码,代码编写需符合《[RT-Thread 编程风格](coding_style_cn.md)》,Git 提交日志信息描述清晰
45+
2. 软件代码尽可能的简洁,保证用户看到的代码清晰,容易理解。在 menuconfig 中也不要开启无关选项
4646

4747
menuconfig 中目录名称说明
4848
```
@@ -57,7 +57,7 @@
5757
```
5858

5959
3. 片上外设驱动统一放在 libraries\drivers 目录下 如 drv_eth.c
60-
4. 扩展板相关的组件 在libraries 目录下创建相关的文件夹,并放置相关代码 如:libraries/audio 目录下存放 drv_wm8988.c 以及 MP3 解码库
60+
4. 扩展板相关的组件在 libraries 目录下创建相关的文件夹并放置相关代码 如:libraries/audio 目录下存放 drv_wm8988.c 以及 MP3 解码库
6161
5. 如果项目中使用到了软件包
6262
- 软件包的版本 **必须** 选择为 **release** 版本。如果没有,请联系管理员尽快发布
6363
- 项目工程 README

0 commit comments

Comments
 (0)