You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
Copy file name to clipboardExpand all lines: src/board/Board_Contribution_Guide.md
+9-7Lines changed: 9 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,18 @@
1
-
# Modification Requirements
1
+
# Board Contribution Guide
2
2
3
3
1. Newly added development boards must ensure the hardware schematics are open-source. Please provide a link or file.
4
4
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:
8
10
9
11
```
10
-
pip3 install pre-commit
12
+
pip3 install pre-commit && pre-commit install
11
13
```
12
14
13
-
# Modification Content
15
+
##Modification Content
14
16
15
17
Using the adaption of the `M5Stack M5CORE2` development board as an example. Following this guide, changes below will be made under the project:
16
18
@@ -32,7 +34,7 @@ Using the adaption of the `M5Stack M5CORE2` development board as an example. Fol
32
34
```
33
35
Note: [A] stands for 'append' and [M] stands for 'modify'
34
36
35
-
# Modification Process
37
+
##Modification Process
36
38
37
39
Using the adaption of `M5Stack M5CORE2` as an example, follow these steps to modify the relevant files:
0 commit comments