Skip to content

Commit 8e61c05

Browse files
Lzw655Lzw655
committed
feat(docs): update README and fix broken links
1 parent 8c3a5be commit 8e61c05

File tree

18 files changed

+205
-161
lines changed

18 files changed

+205
-161
lines changed

‎docs/Board_Contribution_Guide.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Board Contribution Guide
22

3+
* [中文版本](./Board_Contribution_Guide_CN.md)
4+
5+
## Table of Contents
6+
7+
- [Board Contribution Guide](#board-contribution-guide)
8+
- [Table of Contents](#table-of-contents)
9+
- [Contribution Guidelines](#contribution-guidelines)
10+
- [File Modifications](#file-modifications)
11+
- [Adaptation Process](#adaptation-process)
12+
313
## Contribution Guidelines
414

515
1. The development board must at least ensure its hardware schematic is open-source, providing a link or file for reference.

‎docs/Board_Contribution_Guide_CN.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 开发板贡献指南
22

3+
* [English Version](./Board_Contribution_Guide.md)
4+
5+
## 目录
6+
7+
- [开发板贡献指南](#开发板贡献指南)
8+
- [目录](#目录)
9+
- [贡献说明](#贡献说明)
10+
- [文件修改](#文件修改)
11+
- [适配流程](#适配流程)
12+
313
## 贡献说明
414

515
1. 开发板至少需要确保其硬件原理图开源，并提供链接或文件。

‎docs/FAQ.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# FAQ
22

3+
* [中文版本](./FAQ_CN.md)
4+
5+
## Table of Contents
6+
7+
- [FAQ](#faq)
8+
- [Table of Contents](#table-of-contents)
9+
- [Where is the directory for Arduino libraries?](#where-is-the-directory-for-arduino-libraries)
10+
- [How to Install ESP32\_Display\_Panel in Arduino IDE?](#how-to-install-esp32_display_panel-in-arduino-ide)
11+
- [Where are the installation directory for arduino-esp32 and the SDK located?](#where-are-the-installation-directory-for-arduino-esp32-and-the-sdk-located)
12+
- [How to fix screen drift issue when driving RGB LCD with ESP32-S3?](#how-to-fix-screen-drift-issue-when-driving-rgb-lcd-with-esp32-s3)
13+
- [How to Use ESP32\_Display\_Panel on PlatformIO?](#how-to-use-esp32_display_panel-on-platformio)
14+
315
## Where is the directory for Arduino libraries?
416

517
You can find and modify the directory path for Arduino libraries by selecting `File` > `Preferences` > `Settings` > `Sketchbook location` from the menu bar in the Arduino IDE.

‎docs/FAQ_CN.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# 常见问题解答
22

3+
* [English Version](./FAQ.md)
4+
5+
## 目录
6+
7+
- [常见问题解答](#常见问题解答)
8+
- [目录](#目录)
9+
- [Arduino 库的目录在哪儿？](#arduino-库的目录在哪儿)
10+
- [如何在 Arduino IDE 中安装 ESP32\_Display\_Panel？](#如何在-arduino-ide-中安装-esp32_display_panel)
11+
- [arduino-eps32 的安装目录以及 SDK 的目录在哪儿？](#arduino-eps32-的安装目录以及-sdk-的目录在哪儿)
12+
- [使用 ESP32-S3 驱动 RGB LCD 时出现画面漂移问题的解决方案](#使用-esp32-s3-驱动-rgb-lcd-时出现画面漂移问题的解决方案)
13+
- [如何在 PlatformIO 上使用 ESP32\_Display\_Panel？](#如何在-platformio-上使用-esp32_display_panel)
14+
315
## Arduino 库的目录在哪儿？
416

517
您可以在 Arduino IDE 的菜单栏中选择 `File` > `Preferences` > `Settings` > `Sketchbook location` 来查找和修改 Arduino 库的目录路径。

‎docs/_static/block_diagram.drawio‎

Lines changed: 111 additions & 111 deletions
Large diffs are not rendered by default.

‎docs/_static/block_diagram.png‎

339 Bytes
Loading

‎examples/LCD/3wireSPI_RGB/3wireSPI_RGB.ino‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
*
1212
* ## How to use
1313
*
14-
* 1. [Configure drivers](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/How_To_Use.md#configuring-drivers) if needed.
14+
* 1. [Configure drivers](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/How_To_Use.md#configuring-drivers) if needed.
1515
* 2. Modify the macros in the example to match the parameters according to your hardware.
16-
* 3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/How_To_Use.md#configuring-supported-development-boards)
16+
* 3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/How_To_Use.md#configuring-supported-development-boards)
1717
* 4. Verify and upload the example to your ESP board.
1818
*
1919
* ## Serial Output
@@ -36,7 +36,7 @@
3636
*
3737
* ## Troubleshooting
3838
*
39-
* Please check the [FAQ](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/faq.md) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.
39+
* Please check the [FAQ](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/FAQ.md) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.
4040
*
4141
*/
4242

‎examples/LCD/MIPI_DSI/MIPI_DSI.ino‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
*
1212
* ## How to use
1313
*
14-
* 1. [Configure drivers](../../../docs/How_To_Use.md#configuring-drivers) if needed.
14+
* 1. [Configure drivers](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/How_To_Use.md#configuring-drivers) if needed.
1515
* 2. Modify the macros in the example to match the parameters according to your hardware.
16-
* 3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](../../../docs/How_To_Use.md#configuring-supported-development-boards)
16+
* 3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/How_To_Use.md#configuring-supported-development-boards)
1717
* 4. Verify and upload the example to your ESP board.
1818
*
1919
* ## Serial Output
@@ -60,7 +60,7 @@
6060
*
6161
* ## Troubleshooting
6262
*
63-
* Please check the [FAQ](../../../docs/FAQ.md) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.
63+
* Please check the [FAQ](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/FAQ.md) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.
6464
*
6565
*/
6666

‎examples/LCD/QSPI/QSPI.ino‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
*
1212
* ## How to use
1313
*
14-
* 1. [Configure drivers](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/How_To_Use.md#configuring-drivers) if needed.
14+
* 1. [Configure drivers](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/How_To_Use.md#configuring-drivers) if needed.
1515
* 2. Modify the macros in the example to match the parameters according to your hardware.
16-
* 3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/How_To_Use.md#configuring-supported-development-boards)
16+
* 3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/How_To_Use.md#configuring-supported-development-boards)
1717
* 4. Verify and upload the example to your ESP board.
1818
*
1919
* ## Serial Output
@@ -49,7 +49,7 @@
4949
*
5050
* ## Troubleshooting
5151
*
52-
* Please check the [FAQ](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/faq.md) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.
52+
* Please check the [FAQ](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/FAQ.md) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.
5353
*
5454
*/
5555

‎examples/LCD/RGB/RGB.ino‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
*
1212
* ## How to use
1313
*
14-
* 1. [Configure drivers](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/How_To_Use.md#configuring-drivers) if needed.
14+
* 1. [Configure drivers](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/How_To_Use.md#configuring-drivers) if needed.
1515
* 2. Modify the macros in the example to match the parameters according to your hardware.
16-
* 3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/How_To_Use.md#configuring-supported-development-boards)
16+
* 3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters, please refter to [Configuring Supported Development Boards](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/How_To_Use.md#configuring-supported-development-boards)
1717
* 4. Verify and upload the example to your ESP board.
1818
*
1919
* ## Serial Output
@@ -34,7 +34,7 @@
3434
*
3535
* ## Troubleshooting
3636
*
37-
* Please check the [FAQ](https://github.com/esp-arduino-libs/ESP32_Display_Panel/docs/faq.md) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.
37+
* Please check the [FAQ](https://github.com/esp-arduino-libs/ESP32_Display_Panel/blob/master/docs/FAQ.md) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.
3838
*
3939
*/
4040

0 commit comments

Comments
 (0)