fix(docs): correct and add descriptions

Author: Lzw655

.gitlab/ci/rules.yml

@@ -1,5 +1,12 @@
 # ChangeLog
 
+## v1.0.1 - 2025-02-19
+
+### Bugfixes:
+
+* fix(touch): avoid reading the button state when disabled (#162)
+* fix(docs): correct and add descriptions
+
 ## v1.0.0 - 2025-02-17
 
 ### Breaking changes:

CHANGELOG.md

@@ -49,9 +49,11 @@
 - Open Arduino IDE
 - Navigate to `File` > `Preferences`
 - Add to `Additional boards manager URLs`:
-    ```
-    https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
-    ```
+
+  ```
+  https://espressif.github.io/arduino-esp32/package_esp32_index.json
+  ```
+
 - Navigate to `Tools` > `Board` > `Boards Manager`
 - Search for `esp32` by `Espressif Systems` and install the required version (see [SDK & Dependencies](#sdk--dependencies))
 
@@ -65,7 +67,7 @@
 
 1. **Select and Configure Board**
 
-- Navigate to `Tools` > `Board` > `ESP32`
+- Navigate to `Tools` > `Board` > `esp32`
 - Select your board model. If you can't find a matching model, refer to:
 
   - If using a [supported board](../../README.md#supported-boards), see [Configuring Arduino IDE](#configuring-arduino-ide)
@@ -74,7 +76,7 @@
 2. **Open Example**
 
 - Navigate to `File` > `Examples` > `ESP32_Display_Panel`
-- Select `Board` > [`board_static_config`](../../examples/arduino/board/board_static_config/)
+- Select `Arduino` > `board` > [`board_static_config`](../../examples/arduino/board/board_static_config/)
 
 3. **Modify Code**
 

docs/envs/use_with_arduino.md

@@ -49,9 +49,11 @@
 - 打开 Arduino IDE
 - 导航到 `File` > `Preferences`
 - 在 `Additional boards manager URLs` 中添加:
-    ```
-    https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
-    ```
+
+  ```
+  https://espressif.github.io/arduino-esp32/package_esp32_index.json
+  ```
+
 - 导航到 `Tools` > `Board` > `Boards Manager`
 - 搜索 `esp32` by `Espressif Systems` 并安装符合要求的版本（参阅 [SDK 及依赖库](#sdk-及依赖库)）
 
@@ -65,7 +67,7 @@
 
 1. **选择和配置开发板**
 
-- 导航到 `Tools` > `Board` > `ESP32`
+- 导航到 `Tools` > `Board` > `esp32`
 - 选择您的开发板型号。如果未找到匹配的型号，请参考以下信息：
 
   * 如果您正在使用 [支持的开发板](../../README_CN.md#支持的开发板)，可以参阅 [配置 Arduino IDE](#配置-arduino-ide)
@@ -74,7 +76,7 @@
 2. **打开示例**
 
 - 导航到 `File` > `Examples` > `ESP32_Display_Panel`
-- 选择 `Board` > [`board_static_config`](../../examples/arduino/board/board_static_config/)
+- 选择 `Arduino` > `board` > [`board_static_config`](../../examples/arduino/board/board_static_config/)
 
 3. **修改代码**
 

docs/envs/use_with_arduino_cn.md

@@ -13,8 +13,8 @@ using namespace esp_panel::drivers;
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
  * Currently, the library supports the following RGB (without 3-wire SPI) LCDs:
- *      - ST7262
  *      - EK9716B
+ *      - ST7262
  */
 #define EXAMPLE_LCD_NAME                    ST7262
 #define EXAMPLE_LCD_WIDTH                   (800)

examples/arduino/drivers/lcd/lcd_single_rgb/lcd_single_rgb.ino

@@ -13,7 +13,7 @@ This example demonstrates how to port `LVGL v8`. And for `RGB/MIPI-DSI` interfac
 
 - [Optional] `ESP32_Display_Panel`:
 
-  - This example already has the [esp_panel_drivers_conf.h](./src/esp_panel_drivers_conf.h) configuration file in the project directory. Edit this file as needed
+  - This example already has the [esp_panel_board_custom_conf.h](./src/esp_panel_board_custom_conf.h) and [esp_panel_drivers_conf.h](./src/esp_panel_drivers_conf.h) configuration files in the project directory. Edit these files as needed
   - see [Board Configuration Guide](../../../docs/envs/use_with_arduino.md#configuration-guide) for more information
 
 - [Optional] `esp-lib-utils` :
@@ -65,6 +65,7 @@ This example demonstrates how to port `LVGL v8`. And for `RGB/MIPI-DSI` interfac
 
     - Modify the [BOARD_CUSTOM.json](./boards/BOARD_CUSTOM.json) board file by referring to a supported board file which has the same chip as your board.
     - Modify the `[env:BOARD_CUSTOM]` board env in the *platformio.ini* file as needed
+    - Modify the *esp_panel_board_custom_conf.h* file and set `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` to `1`. Then change other configurations as needed in the file
 
   - See [PlatformIO Docs](https://docs.platformio.org/en/latest/projectconf/index.html) for more information
 

examples/platformio/lvgl_v8_port/README.md

@@ -1,4 +1,4 @@
-version: "1.0.0"
+version: "1.0.1"
 description: ESP32_Display_Panel is a display driver and GUI porting library designed by Espressif specifically for ESP series SoCs (ESP32, ESP32-S3, ESP32-P4, etc.)
 url: https://github.com/esp-arduino-libs/ESP32_Display_Panel
 repository: https://github.com/esp-arduino-libs/ESP32_Display_Panel.git

idf_component.yml

@@ -1,5 +1,5 @@
 name=ESP32_Display_Panel
-version=1.0.0
+version=1.0.1
 author=espressif
 maintainer=espressif
 sentence=ESP32_Display_Panel is a display driver and GUI porting library designed by Espressif specifically for ESP series SoCs (ESP32, ESP32-S3, ESP32-P4, etc.)

library.properties

@@ -8,7 +8,7 @@
 /* Library Version */
 #define ESP_PANEL_VERSION_MAJOR 1
 #define ESP_PANEL_VERSION_MINOR 0
-#define ESP_PANEL_VERSION_PATCH 0
+#define ESP_PANEL_VERSION_PATCH 1
 
 /* File `esp_panel_drivers_conf.h` */
 #define ESP_PANEL_DRIVERS_CONF_VERSION_MAJOR 1