feat(docs): optimize files in src/board

Author: MacChu0315-Espressif

ESP_Panel_Board_Supported.h

@@ -76,7 +76,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 1
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif

README.md

@@ -4,7 +4,7 @@
 
 * [中文版本](./README_CN.md)
 
-ESP32_Display_Panel is an Arduino library designed for ESP SoCs to drive display panels and facilitate rapid GUI development. Users can develop directly for a variety of [supported development boards](src/board/README.md) or create custom ones through simple adaptation. Additionally, ESP32_Display_Panel is compatible with various LCD and touch drivers, allowing users to develop using standalone drivers as needed.
+ESP32_Display_Panel is an Arduino library designed for ESP SoCs to drive display panels and facilitate rapid GUI development. Users can develop directly for a variety of [supported development boards](src/board/Board_Instructions.md) or create custom ones through simple adaptation. Additionally, ESP32_Display_Panel is compatible with various LCD and touch drivers, allowing users to develop using standalone drivers as needed.
 
 ESP32_Display_Panel encapsulates various components from the [Espressif Components Registry](https://components.espressif.com/), requiring development based on [arduino-esp32](https://github.com/espressif/arduino-esp32), and can be directly downloaded from the Arduino IDE.
 
@@ -30,6 +30,7 @@ ESP32_Display_Panel encapsulates various components from the [Espressif Componen
       - [LVGL v8](#lvgl-v8)
       - [SquareLine](#squareline)
   - [Other Relevant Instructions](#other-relevant-instructions)
+    - [Configuring Supported Development Boards](#configuring-supported-development-boards)
     - [Configuring LVGL](#configuring-lvgl)
     - [Porting SquareLine Project](#porting-squareline-project)
   - [FAQ](#faq)
@@ -54,15 +55,15 @@ The functional block diagram of ESP32_Display_Panel is as follows, mainly compri
 
 ### Development Boards
 
-Below is a list of [supported development boards](src/board/README.md):
+Below is a list of [supported development boards](src/board/Board_Instructions.md):
 
 | **Manufacturer** | **Board Model** |
 | --------------- | --------------- |
-| [Espressif](src/board/README.md#espressif) | ESP32-C3-LCDkit, ESP32-S3-Box, ESP32-S3-Box-3, ESP32-S3-Box-3(beta), ESP32-S3-Box-Lite, ESP32-S3-EYE, ESP32-S3-Korvo-2, ESP32-S3-LCD-EV-Board, ESP32-S3-LCD-EV-Board-2, ESP32-S3-USB-OTG |
+| [Espressif](src/board/Board_Instructions.md#espressif) | ESP32-C3-LCDkit, ESP32-S3-Box, ESP32-S3-Box-3, ESP32-S3-Box-3(beta), ESP32-S3-Box-Lite, ESP32-S3-EYE, ESP32-S3-Korvo-2, ESP32-S3-LCD-EV-Board, ESP32-S3-LCD-EV-Board-2, ESP32-S3-USB-OTG |
 | [M5Stack](https://m5stack.com/) | M5STACK-M5CORE2 |
-| [Jingcai](src/board/README.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
+| [Jingcai](src/board/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
 
-Developers and manufacturers are welcome to submit PRs to add more development boards.
+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).
 
 ### LCD Controllers
 
@@ -295,6 +296,10 @@ To port the SquareLine project (v1.3.x), please refer to [here](#porting-squarel
 
 ## Other Relevant Instructions
 
+### Configuring Supported Development Boards
+
+For details on how to configure the supported development boards in the Arduino IDE, see [Board_Instructions.md](./src/board/Board_Instructions.md).
+
 ### Configuring LVGL
 
 The functionality and parameters of LVGL can be configured by editing the `lv_conf.h` file, where users can modify macro definitions to update the behavior or default parameters of the driver. Here are some features for configuring LVGL:

README_CN.md

@@ -4,7 +4,7 @@
 
 * [English Version](./README.md)
 
-ESP32_Display_Panel 是专为 ESP SoCs 设计的 Arduino 库，用于驱动显示屏并实现快速 GUI 开发。用户不仅可以直接开发多款[内部支持的开发板](src/board/README.md)，还可以通过简单的适配来开发自定义的开发板。此外，ESP32_Display_Panel 还适配了多款 LCD 和触摸的驱动，用户也可以根据需要使用独立的驱动进行开发。
+ESP32_Display_Panel 是专为 ESP SoCs 设计的 Arduino 库，用于驱动显示屏并实现快速 GUI 开发。用户不仅可以直接开发多款[内部支持的开发板](src/board/Board_Instructions.md)，还可以通过简单的适配来开发自定义的开发板。此外，ESP32_Display_Panel 还适配了多款 LCD 和触摸的驱动，用户也可以根据需要使用独立的驱动进行开发。
 
 ESP32_Display_Panel 封装了多种[乐鑫组件库](https://components.espressif.com/)中相关的组件，需要基于 [arduino-esp32](https://github.com/espressif/arduino-esp32) 进行开发，并且可以直接从 Arduino IDE 中下载获取。
 
@@ -30,6 +30,7 @@ ESP32_Display_Panel 封装了多种[乐鑫组件库](https://components.espressi
       - [LVGL v8](#lvgl-v8)
       - [SquareLine](#squareline)
   - [其他相关说明](#其他相关说明)
+    - [配置支持的开发板](#配置支持的开发板)
     - [配置 LVGL](#配置-lvgl)
     - [移植 SquareLine 工程](#移植-squareline-工程)
   - [常见问题解答](#常见问题解答)
@@ -54,15 +55,15 @@ ESP32_Display_Panel 的功能框图如下所示，主要包含以下特性：
 
 ### 开发板
 
-下面是支持的[开发板列表](src/board/README.md)：
+下面是支持的[开发板列表](src/board/Board_Instructions.md)：
 
 | **厂商** | **开发板型号** |
 | -------- | -------------- |
-| [Espressif](src/board/README.md#espressif) | ESP32-C3-LCDkit, ESP32-S3-Box, ESP32-S3-Box-3, ESP32-S3-Box-3(beta), ESP32-S3-Box-Lite, ESP32-S3-EYE, ESP32-S3-Korvo-2, ESP32-S3-LCD-EV-Board, ESP32-S3-LCD-EV-Board-2, ESP32-S3-USB-OTG |
+| [Espressif](src/board/Board_Instructions.md#espressif) | ESP32-C3-LCDkit, ESP32-S3-Box, ESP32-S3-Box-3, ESP32-S3-Box-3(beta), ESP32-S3-Box-Lite, ESP32-S3-EYE, ESP32-S3-Korvo-2, ESP32-S3-LCD-EV-Board, ESP32-S3-LCD-EV-Board-2, ESP32-S3-USB-OTG |
 | [M5Stack](https://m5stack.com/) | M5STACK-M5CORE2 |
-| [Jingcai](src/board/README.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
+| [Jingcai](src/board/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
 
-欢迎开发者和厂商提交 PR 来添加更多的开发板。
+欢迎开发者和厂商贡献 PR 来添加更多的开发板，详细说明请参考 [`开发板贡献指南`](./src/board/Board_Development_Guide_CN.md)。
 
 ### LCD 控制器
 
@@ -295,6 +296,10 @@ ESP32_Display_Panel 会根据 [ESP_Panel_Board_Custom.h](./ESP_Panel_Board_Custo
 
 ## 其他相关说明
 
+### 配置支持的开发板
+
+关于如何在 Arduino IDE 中配置支持的开发板，请参考 [Board_Instructions.md](./src/board/Board_Instructions.md).
+
 ### 配置 LVGL
 
 LVGL 的功能和参数可以通过编辑 `lv_conf.h` 文件来进行配置，用户可以修改此文件中的宏定义以更新驱动的行为或默认参数。以下是配置 LVGL 的一些特点和步骤：

examples/LVGL/v8/Porting/ESP_Panel_Board_Supported.h

@@ -76,7 +76,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 1
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif

examples/LVGL/v8/Rotation/ESP_Panel_Board_Supported.h

@@ -76,7 +76,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 1
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif

examples/Panel/PanelTest/ESP_Panel_Board_Supported.h

@@ -76,7 +76,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 1
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif

examples/SquareLine/v8/Porting/ESP_Panel_Board_Supported.h

@@ -76,7 +76,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 1
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif

examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Supported.h

@@ -76,7 +76,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 1
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif

src/ESP_PanelVersions.h

@@ -25,8 +25,8 @@
 
 /* File `ESP_Panel_Board_Supported.h` */
 #define ESP_PANEL_BOARD_SUPPORTED_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_SUPPORTED_VERSION_PATCH 1
+#define ESP_PANEL_BOARD_SUPPORTED_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_VERSION_PATCH 0
 
 /* Check if the current configuration file version is compatible with the library version */
 // File `ESP_Panel_Conf.h`

src/board/Board_Development_Guide.md

@@ -2,10 +2,17 @@
 
 1. Newly added development boards must ensure the hardware schematics are open-source. Please provide a link or file.
 2. This library currently only supports the APIs provided in ESP-IDF. It does not support other Arduino library APIs, such as Wire.
+3. It is recommended to use the vscode + Arduino CLI development environment.
+4. Pull the ESP32_Display_Panel repository into the Arduino library directory before making modifications.
+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:
+
+```
+pip3 install pre-commit
+```
 
 # Modification Content
 
-Using the adaption of the M5Stack M5CORE2 development board as an example. Following this guide, changes below will be made under the project:
+Using the adaption of the `M5Stack M5CORE2` development board as an example. Following this guide, changes below will be made under the project:
 
 ```
 | -ESP32_Display_Panel
@@ -23,39 +30,30 @@ Using the adaption of the M5Stack M5CORE2 development board as an example. Follo
    | -README_CN.md                     [M]
    | -README.md                        [M]
 ```
+Note: [A] stands for 'append' and [M] stands for 'modify'
 
 # Modification Process
 
-Using the adaption of M5Stack M5CORE2 as an example, follow these steps to modify the relevant files:
+Using the adaption of `M5Stack M5CORE2` as an example, follow these steps to modify the relevant files:
 
-1. **[M] ESP_Panel_Board_Supported**: Add a macro for the new development board, such as BOARD_M5STACK_M5CORE2. Ensure the macro is in uppercase. Include the manufacturer's name and link, as well as the target development board's link.
-2. **[A] src/board/m5stack/M5CORE2.h**: Use the ESP_Panel_Board_Custom.h file in the root directory as a template to create a new configuration header file for the development board. Follow the naming conventions of existing development boards.
-3. **[M] src/board/ESP_PanelBoard.h**: Add the macro check for the new development board by referring to the existing boards in the file, and modify the file to use the correct header file for this development board.
+1. **[M]** *[ESP_Panel_Board_Supported.h](../../ESP_Panel_Board_Supported.h)*: Add a macro for the new development board, such as `BOARD_M5STACK_M5CORE2`. Ensure the macro is in uppercase. Include the manufacturer's name and link, as well as the target development board's link.
+2. **[A]** *[src/board/m5stack/M5CORE2.h](../board/m5stack/M5CORE2.h)*: Use the *ESP_Panel_Board_Custom.h* file in the root directory as a template to create a new configuration header file for the development board. Follow the naming conventions of existing development boards.
+3. **[M]** *[src/board/ESP_PanelBoard.h](../board/ESP_PanelBoard.h)*: Add the macro check for the new development board by referring to the existing boards in the file, and modify the file to use the correct header file for this development board.
 
    **Note**: At this point, you can verify the above steps:
 
-      - Choose an example, such as examples/Panel/PanelTest.
-      - **[M] examples/Panel/PanelTest/ESP_Panel_Board_Supported.h**: Modify the ESP_PANEL_USE_SUPPORTED_BOARD macro to enable this header file. Define the development board macro, such as BOARD_M5STACK_M5CORE2, to enable the new header file src/board/m5stack/M5CORE2.h.
+      - Choose an example, such as *[examples/Panel/PanelTest](../../examples/Panel/PanelTest/)*.
+      - modify the macro `ESP_PANEL_USE_SUPPORTED_BOARD` to enable this header file. Define the development board macro, such as `BOARD_M5STACK_M5CORE2`, to enable the new header file *[src/board/m5stack/M5CORE2.h](../board/m5stack/M5CORE2.h)*.
       - Verify the example's ino file. If successful, proceed to the following steps.
 
-4. Modify the configuration header file for the new development board:
+4. **[M]** *[src/board/m5stack/M5CORE2.h](../board/m5stack/M5CORE2.h)*: Modify the configuration header file for the new development board:
    - Review the hardware schematics of the development board, focusing on the BUS type used for the LCD screen, the LCD driver name, the BUS type used for touch, the touch driver name, and the chip pin numbers used for each interface of the LCD and touch.
-   - **[M] src/board/m5stack/M5CORE2.h**: The best practice is to first get the screen working, then work on the touch functionality.
+   - The best practice is to first get the screen working, then work on the touch functionality.
    - If the new development board's driver is compatible with an existing driver, there is no need to add a new driver. Simply note in the comments that this driver is compatible with an existing one and use the existing driver.
-   - If the driver used by the new development board is not compatible with existing drivers or has other special configurations, you can achieve this by modifying the macro functions at the end of the new development board's configuration header file, such as ESP_PANEL_BEGIN_BACKLIGHT_START_FUNCTION, ESP_PANEL_BEGIN_END_FUNCTION, etc. Refer to src/board/espressif/ESP32_S3_BOX_3.h or src/board/m5stack/M5CORE2.h for specific implementations.
-   - Run examples other than examples/LCD and examples/Touch, and continuously adjust the configuration header file to ensure correct settings.
-
-5. **[M] ESP_Panel_Board_Supported, library.properties, board/README.md, README_CN.md, README.md**: Update the supported development boards information in these files.
-6. **[M] src/board/README.md**: Update the recommended configuration for the new development board.
-7. **[M] src/ESP_PanelVersions.h**: Ensure that the version under "Library Version" should be ahead of the latest tag version in terms of the minor version; when changes occur to ESP_Panel_Board_Custom.h, ESP_Panel_Board_Supported.h, and ESP_Panel_Conf.h in the root directory, the minor version number at the end of the corresponding file should be increased by one, and it should be ensured that the File ESP_Panel_Conf.h, File ESP_Panel_Board_Custom.h, and File ESP_Panel_Board_Supported.h in src/ESP_PanelVersions.h match the versions of the corresponding files.
-8. **[M] CHANGELOG.md**: Update the changelog
+   - If the driver used by the new development board is not compatible with existing drivers or has other special configurations, you can achieve this by modifying the macro functions at the end of the new development board's configuration header file, such as `ESP_PANEL_BEGIN_BACKLIGHT_START_FUNCTION`, `ESP_PANEL_BEGIN_END_FUNCTION`, etc. Refer to *[src/board/espressif/ESP32_S3_BOX_3.h](../board/espressif/ESP32_S3_BOX_3.h)* or *[src/board/m5stack/M5CORE2.h](../board/m5stack/M5CORE2.h)* for specific implementations.
+   - Run examples other than *[examples/LCD](../../examples/LCD/)* and *[examples/Touch](../../examples/Touch/)*, and continuously adjust the configuration header file to ensure correct settings.
 
-# Notes
-
-1. It is recommended to use the vscode + Arduino CLI development environment.
-2. Pull the ESP32_Display_Panel repository into the Arduino library directory before making modifications.
-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:
-
-```
-pip3 install pre-commit
-```
+5. **[M]** *[ESP_Panel_Board_Supported](../../ESP_Panel_Board_Supported.h)*, *[library.properties](../../library.properties)*, *[board/Board_Instructions.md](../board/Board_Instructions.md)*, *[README_CN.md](../../README_CN.md)*, *[README.md](../../README.md)*: Update the supported development boards information in these files.
+6. **[M]** *[src/board/Board_Instructions.md](../board/Board_Instructions.md)*: Update the recommended configuration for the new development board.
+7. **[M]** *[src/ESP_PanelVersions.h](../ESP_PanelVersions.h)*: Ensure that the version under `Library Version` should be ahead of the latest tag version in terms of the minor version; when changes occur to *[ESP_Panel_Board_Custom.h](../../ESP_Panel_Board_Custom.h)*, *[ESP_Panel_Board_Supported.h](../../ESP_Panel_Board_Supported.h)*, and *[ESP_Panel_Conf.h](../../ESP_Panel_Conf.h)* in the root directory, the minor version number but patch version number at the end of the corresponding file and at the beginging of *[src/ESP_PanelVersions.h](../ESP_PanelVersions.h)* should be increased by one and reset the patch version number to 0.
+8. **[M]** *[CHANGELOG.md](../../CHANGELOG.md)*: Update the changelog.