Skip to content

Commit 8220bcc

Browse files
author
MacChu0315-Espressif
committed
feat(docs): update some docs
1 parent f8534be commit 8220bcc

File tree

4 files changed

+20
-16
lines changed

4 files changed

+20
-16
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Below is a list of [supported development boards](src/board/Board_Instructions.m
6363
| [M5Stack](https://m5stack.com/) | M5STACK-M5CORE2 |
6464
| [Jingcai](src/board/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
6565

66-
Developers and manufacturers are welcomed to contribute PRs to add more development boards. For detailed instructions, please refer to the [`Board Development Guide`](./src/board/Board_Development_Guide.md).
66+
Developers and manufacturers are welcomed to contribute PRs to add more development boards. For detailed instructions, please refer to the [`Board Development Guide`](./src/board/Board_Contribution_Guide.md).
6767

6868
### LCD Controllers
6969

README_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ ESP32_Display_Panel 的功能框图如下所示,主要包含以下特性:
6363
| [M5Stack](https://m5stack.com/) | M5STACK-M5CORE2 |
6464
| [Jingcai](src/board/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
6565

66-
欢迎开发者和厂商贡献 PR 来添加更多的开发板,详细说明请参考 [`开发板贡献指南`](./src/board/Board_Development_Guide_CN.md)
66+
欢迎开发者和厂商贡献 PR 来添加更多的开发板,详细说明请参考 [`开发板贡献指南`](./src/board/Board_Contribution_Guide_CN.md)
6767

6868
### LCD 控制器
6969

src/board/Board_Development_Guide.md renamed to src/board/Board_Contribution_Guide.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
# Modification Requirements
1+
# Board Contribution Guide
22

33
1. Newly added development boards must ensure the hardware schematics are open-source. Please provide a link or file.
44
2. This library currently only supports the APIs provided in ESP-IDF. It does not support other Arduino library APIs, such as Wire.
5-
3. It is recommended to use the vscode + Arduino CLI development environment.
6-
4. Pull the ESP32_Display_Panel repository into the Arduino library directory before making modifications.
7-
5. The project uses pre-commit to enforce commit standards. It is recommended to install the pre-commit library before committing using the following command:
5+
6+
**Note**:
7+
1. It is recommended to use the vscode + Arduino CLI development environment.
8+
2. Pull the ESP32_Display_Panel repository into the Arduino library directory before making modifications.
9+
3. The project uses pre-commit to enforce commit standards. It is recommended to install the pre-commit library before committing using the following command:
810

911
```
10-
pip3 install pre-commit
12+
pip3 install pre-commit && pre-commit install
1113
```
1214

13-
# Modification Content
15+
## Modification Content
1416

1517
Using the adaption of the `M5Stack M5CORE2` development board as an example. Following this guide, changes below will be made under the project:
1618

@@ -32,7 +34,7 @@ Using the adaption of the `M5Stack M5CORE2` development board as an example. Fol
3234
```
3335
Note: [A] stands for 'append' and [M] stands for 'modify'
3436

35-
# Modification Process
37+
## Modification Process
3638

3739
Using the adaption of `M5Stack M5CORE2` as an example, follow these steps to modify the relevant files:
3840

src/board/Board_Development_Guide_CN.md renamed to src/board/Board_Contribution_Guide_CN.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
# 修改要求
1+
# 开发板贡献指南
22

33
1. 新添加的开发板需要确保硬件原理图开源,需要提供链接或文件。
44
2. 该库目前仅支持 ESP-IDF 提供的 API,不支持其他 Arduino 库 API,如 Wire。
5-
3. 推荐使用 vscode + Arduino CLI 开发环境。
6-
4. 在进行修改之前,将 ESP32_Display_Panel 仓库拉入 Arduino 库目录中。
7-
5. 项目使用 pre-commit 来规范提交内容,因此建议在提交之前安装 pre-commit 库,使用以下命令:
5+
6+
**注意**
7+
1. 推荐使用 vscode + Arduino CLI 开发环境。
8+
2. 在进行修改之前,将 ESP32_Display_Panel 仓库拉入 Arduino 库目录中。
9+
3. 项目使用 pre-commit 来规范提交内容,因此建议在提交之前安装 pre-commit 库,使用以下命令:
810

911
```
10-
pip3 install pre-commit
12+
pip3 install pre-commit && pre-commit install
1113
```
1214

13-
# 修改内容
15+
## 需修改内容
1416

1517
以适配 `M5Stack M5CORE2` 开发板为例。按照本指南,以下更改将在项目中进行:
1618

@@ -32,7 +34,7 @@ pip3 install pre-commit
3234
```
3335
注:[A] 代表 '添加',[M] 代表 '修改'
3436

35-
# 修改流程
37+
## 各文件修改流程
3638

3739
以适配 `M5Stack M5CORE2` 为例,按照以下步骤修改相关文件:
3840

0 commit comments

Comments
 (0)