Skip to content

Commit 5841f55

Browse files
arminkarmink
authored
Merge pull request #31 from yangjie11/en
【增加】增加英文 readme
2 parents 098615a + efca382 commit 5841f55

File tree

2 files changed

+90
-30
lines changed

2 files changed

+90
-30
lines changed

‎README.md‎

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,39 @@
11
# peripheral samples package
22

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

5-
这个软件包包含一些外设设备操作的例程。
5+
## 1. Introduction
66

7-
### 1.1 例程说明
7+
This package contains some routines for the operation of peripheral devices.
88

9-
| 文件 | 说明 |
9+
### 1.1 Example description
10+
11+
| File | Description |
1012
| ---------------- | ------------------------------- |
11-
| adc_vol_sample.c | 使用 ADC 设备转换电压数据 |
12-
| hwtimer_sample.c | 使用 硬件定时器定时 |
13-
| i2c_aht10_sample.c | 使用 i2c 设备获取 aht10 温湿度传感器数据 |
14-
| iwdg_sample.c | 看门狗设备使用示例 |
15-
| led_blink_sample.c | 使用 pin 设备控制 LED 闪烁 |
16-
| pin_beep_sample.c | 使用 pin 设备控制蜂鸣器 |
17-
| pwm_led_sample.c | 使用 pwm 设备控制 LED 的亮度 |
18-
| rtc_sample.c | 使用 rtc 设备设置年月日时分秒信息 |
19-
| sd_sample.c | 块设备 SD 卡使用示例 |
20-
| spi_w25q_sample.c | 使用 spi 设备读取 W25Q ID |
21-
| uart_sample.c | 使用 serial 设备中断接收及轮询发送模式收发数据 |
22-
| uart_dma_sample.c | 使用 serial 设备 DMA 接收及轮询发送模式收发数据 |
13+
| adc_vol_sample.c | Use ADC device to convert voltage data |
14+
| hwtimer_sample.c | Use hardware timer timing |
15+
| i2c_aht10_sample.c | Use i2c device to obtain aht10 temperature and humidity sensor data |
16+
| iwdg_sample.c | Watchdog device usage example |
17+
| led_blink_sample.c | Use pin device to control LED blinking |
18+
| pin_beep_sample.c | Use pin device to control buzzer |
19+
| pwm_led_sample.c | Use pwm device to control LED brightness |
20+
| rtc_sample.c | Use rtc device to set year, month, day, hour, minute and second information |
21+
| sd_sample.c | Block device SD card usage example |
22+
| spi_w25q_sample.c | Use spi device to read W25Q ID |
23+
| uart_sample.c | Send and receive data using serial device interrupt receiving and polling sending mode |
24+
| uart_dma_sample.c | Use serial device DMA reception and polling transmission mode to send and receive data |
2325

24-
### 1.2 许可证
26+
### 1.2 License
2527

26-
peripheral samples package 遵循 Apache license v2.0 许可，详见 `LICENSE` 文件。
28+
The peripheral samples package complies with the Apache license v2.0, see the `LICENSE` file for details.
2729

28-
### 1.3 依赖
30+
### 1.3 Dependency
2931

30-
依赖设备管理模块提供的设备驱动。
32+
Depend on the device driver provided by the device management module.
3133

32-
## 2、如何打开 peripheral samples package
34+
## 2. How to open the peripheral samples package
3335

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

3638
```
3739
RT-Thread online packages
@@ -40,17 +42,17 @@ RT-Thread online packages
4042
a peripheral_samples package for rt-thread --->
4143
```
4244

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

45-
## 3、使用 peripheral samples package
47+
## 3. Use peripheral samples package
4648

47-
在打开 peripheral samples package 后，当进行 BSP 编译时，选择的软件包相关源代码会被加入到 BSP 工程中进行编译。
49+
After opening the peripheral samples package, when the BSP is compiled, the relevant source code of the selected software package will be added to the BSP project for compilation.
4850

49-
## 4、注意事项
51+
## 4. Matters needing attention
5052

51-
暂无。
53+
Nothing.
5254

53-
## 5、联系方式 & 感谢
55+
## 5. Contact & Thanks
5456

55-
* 维护：[misonyo](https://github.com/misonyo)
56-
* 主页：https://github.com/RT-Thread-packages/peripheral-sample
57+
* Maintenance: [misonyo](https://github.com/misonyo)
58+
* Homepage: https://github.com/RT-Thread-packages/peripheral-sample

‎README_ZH.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# peripheral samples package
2+
3+
中文页 | [English](README.md)
4+
5+
## 1、介绍
6+
7+
这个软件包包含一些外设设备操作的例程。
8+
9+
### 1.1 例程说明
10+
11+
| 文件 | 说明 |
12+
| ---------------- | ------------------------------- |
13+
| adc_vol_sample.c | 使用 ADC 设备转换电压数据 |
14+
| hwtimer_sample.c | 使用 硬件定时器定时 |
15+
| i2c_aht10_sample.c | 使用 i2c 设备获取 aht10 温湿度传感器数据 |
16+
| iwdg_sample.c | 看门狗设备使用示例 |
17+
| led_blink_sample.c | 使用 pin 设备控制 LED 闪烁 |
18+
| pin_beep_sample.c | 使用 pin 设备控制蜂鸣器 |
19+
| pwm_led_sample.c | 使用 pwm 设备控制 LED 的亮度 |
20+
| rtc_sample.c | 使用 rtc 设备设置年月日时分秒信息 |
21+
| sd_sample.c | 块设备 SD 卡使用示例 |
22+
| spi_w25q_sample.c | 使用 spi 设备读取 W25Q ID |
23+
| uart_sample.c | 使用 serial 设备中断接收及轮询发送模式收发数据 |
24+
| uart_dma_sample.c | 使用 serial 设备 DMA 接收及轮询发送模式收发数据 |
25+
26+
### 1.2 许可证
27+
28+
peripheral samples package 遵循 Apache license v2.0 许可，详见 `LICENSE` 文件。
29+
30+
### 1.3 依赖
31+
32+
依赖设备管理模块提供的设备驱动。
33+
34+
## 2、如何打开 peripheral samples package
35+
36+
使用 peripheral samples package 需要在 RT-Thread 的包管理器中选择它，具体路径如下：
37+
38+
```
39+
RT-Thread online packages
40+
miscellaneous packages --->
41+
samples: kernel and components samples --->
42+
a peripheral_samples package for rt-thread --->
43+
```
44+
45+
然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。
46+
47+
## 3、使用 peripheral samples package
48+
49+
在打开 peripheral samples package 后，当进行 BSP 编译时，选择的软件包相关源代码会被加入到 BSP 工程中进行编译。
50+
51+
## 4、注意事项
52+
53+
暂无。
54+
55+
## 5、联系方式 & 感谢
56+
57+
* 维护：[misonyo](https://github.com/misonyo)
58+
* 主页：https://github.com/RT-Thread-packages/peripheral-sample

0 commit comments

Comments
 (0)