Merge branch 'bugfix/fix_readme_links' into 'master'

bugfix: fix readme links

Closes DOC-10154

See merge request ae_group/esp-dev-kits!276

docs/TEMPLATE_EXAMPLE_README_CN.md

@@ -2,9 +2,9 @@ _请注意，本文档为 esp-dev-kits 示例 README.md 文件的模板。在使
 
 # _示例标题_
 
-_英文版本链接_
+_英文版本链接。请参考以下示例。_
 
-[英文版本](./README_EN.md)
+[英文版本](./TEMPLATE_EXAMPLE_README_EN.md)
 
 _介绍该示例的功能。介绍部分应尽量回答以下几个问题：_
 - _该示例是什么？有什么用？_

docs/TEMPLATE_EXAMPLE_README_EN.md

@@ -2,9 +2,9 @@ _Note that this is a template for an esp-dev-kits example README.md file. When u
 
 # _Example Title_
 
-_Link to Chinese Version_
+_Link to Chinese Version. Below is an example._
 
-[中文版本](./README_CN.md)
+[中文版本](./TEMPLATE_EXAMPLE_README_CN.md)
 
 _Introduce the functionality demonstrated by the example. The introduction should preferably answer the following questions:_
 - _What is this example? What does it do?_

examples/esp32-p4-function-ev-board/examples/lvgl_demo_v8/README.md

@@ -11,7 +11,7 @@ This example demonstrates how to port LVGL v8 and conduct performance testing us
 ### Prerequisites
 
 * An ESP32-P4-Function-EV-Board.
-* A 7-inch 1024 x 600 LCD screen powered by the [EK79007](../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_driver_chip_EK79007AD_datasheet.pdf) IC, accompanied by a 32-pin FPC connection [adapter board](../../docs/_static/esp32-p4-function-ev-board/schematics/esp32-p4-function-ev-board-lcd-subboard-schematics.pdf) ([LCD Specifications](../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_datasheet.pdf)).
+* A 7-inch 1024 x 600 LCD screen powered by the [EK79007](../../../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_driver_chip_EK79007AD_datasheet.pdf) IC, accompanied by a 32-pin FPC connection [adapter board](../../../../docs/_static/esp32-p4-function-ev-board/schematics/esp32-p4-function-ev-board-lcd-subboard-schematics.pdf) ([LCD Specifications](../../../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_datasheet.pdf)).
 * A USB-C cable for power supply and programming.
 * Please refer to the following steps for the connection:
     * **Step 1**. According to the table below, connect the pins on the back of the screen adapter board to the corresponding pins on the development board.

examples/esp32-p4-function-ev-board/examples/lvgl_demo_v8/README_CN.md

@@ -9,7 +9,7 @@
 ### 准备工作
 
 * 一块 ESP32-P4-Function-EV-Board 开发板。
-* 一块由 [EK79007](../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_driver_chip_EK79007AD_datasheet.pdf) 芯片驱动的 7 英寸 1024 x 600 LCD 屏幕，配有 32 针 FPC 连接 [适配板](../../docs/_static/esp32-p4-function-ev-board/schematics/esp32-p4-function-ev-board-lcd-subboard-schematics.pdf) ([LCD 规格](../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_datasheet.pdf))。
+* 一块由 [EK79007](../../../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_driver_chip_EK79007AD_datasheet.pdf) 芯片驱动的 7 英寸 1024 x 600 LCD 屏幕，配有 32 针 FPC 连接 [适配板](../../../../docs/_static/esp32-p4-function-ev-board/schematics/esp32-p4-function-ev-board-lcd-subboard-schematics.pdf) ([LCD 规格](../../../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_datasheet.pdf))。
 * 用于供电和编程的 USB-C 电缆。
 * 请参考以下步骤进行连接：
     * **步骤 1**. 根据下表，将屏幕适配板背面的引脚连接到开发板的相应引脚。

examples/esp32-p4-function-ev-board/examples/lvgl_demo_v9/README.md

@@ -11,7 +11,7 @@ This example demonstrates how to port LVGL v9 and conduct performance testing us
 ### Prerequisites
 
 * An ESP32-P4-Function-EV-Board.
-* A 7-inch 1024 x 600 LCD screen powered by the [EK79007](../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_driver_chip_EK79007AD_datasheet.pdf) IC, accompanied by a 32-pin FPC connection [adapter board](../../docs/_static/esp32-p4-function-ev-board/schematics/esp32-p4-function-ev-board-lcd-subboard-schematics.pdf) ([LCD Specifications](../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_datasheet.pdf)).
+* A 7-inch 1024 x 600 LCD screen powered by the [EK79007](../../../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_driver_chip_EK79007AD_datasheet.pdf) IC, accompanied by a 32-pin FPC connection [adapter board](../../../../docs/_static/esp32-p4-function-ev-board/schematics/esp32-p4-function-ev-board-lcd-subboard-schematics.pdf) ([LCD Specifications](../../../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_datasheet.pdf)).
 * A USB-C cable for power supply and programming.
 * Please refer to the following steps for the connection:
     * **Step 1**. According to the table below, connect the pins on the back of the screen adapter board to the corresponding pins on the development board.

examples/esp32-p4-function-ev-board/examples/lvgl_demo_v9/README_CN.md

@@ -9,7 +9,7 @@
 ### 准备工作
 
 * 一块 ESP32-P4-Function-EV-Board 开发板。
-* 一块由 [EK79007](../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_driver_chip_EK79007AD_datasheet.pdf) 芯片驱动的 7 英寸 1024 x 600 LCD 屏幕，配有 32 针 FPC 连接 [适配板](../../docs/_static/esp32-p4-function-ev-board/schematics/esp32-p4-function-ev-board-lcd-subboard-schematics.pdf) ([LCD 规格](../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_datasheet.pdf))。
+* 一块由 [EK79007](../../../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_driver_chip_EK79007AD_datasheet.pdf) 芯片驱动的 7 英寸 1024 x 600 LCD 屏幕，配有 32 针 FPC 连接 [适配板](../../../../docs/_static/esp32-p4-function-ev-board/schematics/esp32-p4-function-ev-board-lcd-subboard-schematics.pdf) ([LCD 规格](../../../../docs/_static/esp32-p4-function-ev-board/camera_display_datasheet/display_datasheet.pdf))。
 * 用于供电和编程的 USB-C 电缆。
 * 请参考以下步骤进行连接：
     * **步骤 1**. 根据下表，将屏幕适配板背面的引脚连接到开发板的相应引脚。

examples/esp32-s2-hmi-devkit-1/README.md

@@ -14,7 +14,3 @@
 * [Smart-Panel](./examples/smart-panel/)
 * [Storage](./examples/storage/)
 
-## Tools
-
-* [LVGL](./tools/lvgl/)
-

examples/esp32-s2-hmi-devkit-1/examples/freetype/main/lv_lib_freetype/README.md

@@ -32,4 +32,4 @@ lv_label_set_text(label, "Hello world");
 
 ## Learn more
 - FreeType [tutorial](https://www.freetype.org/freetype2/docs/tutorial/step1.html) 
-- LVGL's [font interface](https://docs.lvgl.io/v7/en/html/overview/font.html#add-a-new-font-engine)
+- LVGL's [font interface](https://docs.lvgl.io/master/details/main-components/font.html#adding-a-new-font-engine)

examples/esp32-s2-hmi-devkit-1/examples/get-started/led_blink/README.md

@@ -2,7 +2,7 @@
 
 Blink WS2812 LED and show the color on screen.
 
-[WS2812](http://www.world-semi.com/Certifications/WS2812B.html) is a digital RGB LED which integrates a driver circuit and a single control wire. The protocol data format defined in WS2812 is compatible to that in RMT peripheral. This example will illustrate how to drive an WS2812 LED strip based on the RMT driver.
+WS2812 is a digital RGB LED which integrates a driver circuit and a single control wire. The protocol data format defined in WS2812 is compatible to that in RMT peripheral. This example will illustrate how to drive an WS2812 LED strip based on the RMT driver.
 
 ## How to Use Example
 

examples/esp32-s2-kaluga-1/examples/adc_button/README_cn.md

@@ -8,8 +8,8 @@
 
 <table>
     <tr>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP32-S2-Kaluga_V1.0_mainbody.png" width="300" ><p align=center>ESP32-S2-Kaluga-1 开发板</p></td>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraT-8311A-V1.0.png" width="300"><p align=center>ESP-LyraT-8311A 音频板</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP32-S2-Kaluga_V1.0_mainbody.png" width="300" ><p align=center>ESP32-S2-Kaluga-1 开发板</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraT-8311A-V1.0.png" width="300"><p align=center>ESP-LyraT-8311A 音频板</p></td>
     </tr>
 </table>
 

examples/esp32-s2-kaluga-1/examples/camera/README_cn.md

@@ -8,9 +8,9 @@
 
 <table>
     <tr>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP32-S2-Kaluga_V1.0_mainbody.png" width="300" ><p align=center>ESP32-S2-Kaluga-1 开发板</p></td>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraP-LCD32_V1.0.png" width="300"><p align=center>ESP-LyraP-LCD32 显示屏</p></td>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraP-CAM_V1.0.png" width="300"><p align=center>ESP-LyraP-CAM 摄像头</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP32-S2-Kaluga_V1.0_mainbody.png" width="300" ><p align=center>ESP32-S2-Kaluga-1 开发板</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraP-LCD32_V1.0.png" width="300"><p align=center>ESP-LyraP-LCD32 显示屏</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraP-CAM_V1.0.png" width="300"><p align=center>ESP-LyraP-CAM 摄像头</p></td>
     </tr>
 </table>
 
@@ -19,15 +19,15 @@
 1. 将 SW3 和 SW4 的拨码开关**全部打开（ ON ）**，即主板左下角两组拨码开关，如下图：
 * 高级：如果想使用部分触摸板  管脚，只需将触摸板相关拨码开关关闭( OFF )，详情请参阅主板和触摸板原理图。
 
-<div align="left"><img src="../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_camera_1.jpg" width = "450" alt="image 1-2" align=center /></div>
+<div align="left"><img src="../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_camera_1.jpg" width = "450" alt="image 1-2" align=center /></div>
 
 2. 将显示屏插入主板双排排针的内侧一排（注意：不要在显示屏和主板之间接入音频板），如下图:
 
-<div align="left"><img src="../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_lcd_1.jpg" width = "450" alt="image 1-2" align=center /></div>
+<div align="left"><img src="../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_lcd_1.jpg" width = "450" alt="image 1-2" align=center /></div>
 
 3. 将摄像头插入主板，如下图:
 
-<div align="left"><img src="../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_camera_2.jpg" width = "450" alt="image 1-2" align=center /></div>
+<div align="left"><img src="../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_camera_2.jpg" width = "450" alt="image 1-2" align=center /></div>
 
 * ESP32_S2_Kaluga-1 LCD 管脚分配
 
@@ -169,6 +169,6 @@ I (1015) main: camera init done
 ## 2 附录
 
 * [ESP32-S2 技术规格书](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_cn.pdf)
-* [ESP32-S2-Kaluga-1 主板](../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP32-S2-KALUGA-1_V1_2_20200325A.pdf)
-* [ESP-LyraP-CAM 摄像头](../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP-LYRAP-CAM_V1_20200302.pdf)
-* [ESP-LyraP-LCD32 显示屏](../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP-LYRAP-LCD32_V1_1_20200324A.pdf)
+* [ESP32-S2-Kaluga-1 主板](../../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP32-S2-KALUGA-1_V1_2_20200325A.pdf)
+* [ESP-LyraP-CAM 摄像头](../../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP-LYRAP-CAM_V1_20200302.pdf)
+* [ESP-LyraP-LCD32 显示屏](../../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP-LYRAP-LCD32_V1_1_20200324A.pdf)

examples/esp32-s2-kaluga-1/examples/lcd/README_cn.md

@@ -8,8 +8,8 @@
 
 <table>
     <tr>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP32-S2-Kaluga_V1.0_mainbody.png" width="300" ><p align=center>ESP32-S2-Kaluga-1 开发板</p></td>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraP-LCD32_V1.0.png" width="300"><p align=center>ESP-LyraP-LCD32 显示屏</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP32-S2-Kaluga_V1.0_mainbody.png" width="300" ><p align=center>ESP32-S2-Kaluga-1 开发板</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraP-LCD32_V1.0.png" width="300"><p align=center>ESP-LyraP-LCD32 显示屏</p></td>
     </tr>
 </table>
 
@@ -18,11 +18,11 @@
 1. 将 SW3 和 SW4 的拨码开关全部打开（ ON ），即主板左下角两组拨码开关，如下图：
 * 高级：如果想使用部分触摸板 GPIO 管脚，只需将触摸板相关拨码开关关闭OFF，详情请参阅主板和触摸板原理图。
 
-<div align="left"><img src="../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_camera_1.jpg" width = "650" alt="image 1-2" align=center /></div>
+<div align="left"><img src="../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_camera_1.jpg" width = "650" alt="image 1-2" align=center /></div>
 
 2. 将显示屏插入主板双排排针的内侧一排，如下图:
 
-<div align="left"><img src="../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_lcd_1.jpg" width = "650" alt="image 1-2" align=center /></div>
+<div align="left"><img src="../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_lcd_1.jpg" width = "650" alt="image 1-2" align=center /></div>
 
 * ESP32_S2_kaluga-1_v1.1 LCD 管脚分配
 
@@ -59,7 +59,7 @@ idf.py -p PORT flash monitor
 
 当程序烧录进去后，你会看到如下场景，则烧录成功。
 
-![lcd展示图](../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_lcd_2.jpg)
+![lcd展示图](../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_lcd_2.jpg)
 
 您还可以在串行监视器上看到以下输出日志:
 
@@ -127,5 +127,5 @@ I (737) LCD: ST7789V initialization.
 ## 2 附录
 
 * [ESP32-S2 技术规格书](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_cn.pdf)
-* [ESP32-S2-Kaluga-1 主板原理图](../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP32-S2-KALUGA-1_V1_2_20200325A.pdf)
-* [ESP-LyraP-LCD32 显示屏原理图](../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP-LYRAP-LCD32_V1_1_20200324A.pdf)
+* [ESP32-S2-Kaluga-1 主板原理图](../../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP32-S2-KALUGA-1_V1_2_20200325A.pdf)
+* [ESP-LyraP-LCD32 显示屏原理图](../../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP-LYRAP-LCD32_V1_1_20200324A.pdf)

examples/esp32-s2-kaluga-1/examples/touch/README_cn.md

@@ -12,23 +12,23 @@ PHOTO | PLAY/PAUSE | NETWORK | RECORD | VOL_UP | VOL_DOWN |
 
 <table>
     <tr>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP32-S2-Kaluga_V1.0_mainbody.png" width="300" ><p align=center>ESP32-S2-Kaluga-1 开发板</p></td>
-        <td ><img src="../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraP-TOUCHA_V1.0.png" width="300"><p align=center>ESP-LyraP-TOUCHA 触摸板</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP32-S2-Kaluga_V1.0_mainbody.png" width="300" ><p align=center>ESP32-S2-Kaluga-1 开发板</p></td>
+        <td ><img src="../../../../docs/_static/esp32-s2-kaluga-1/ESP-LyraP-TOUCHA_V1.0.png" width="300"><p align=center>ESP-LyraP-TOUCHA 触摸板</p></td>
     </tr>
 </table>
 
 ### 1.2 硬件连接
 
 1. 将 SW3 和 SW4 的拨码开关全部关闭（ OFF ）,即主板左下角两组拨码开关，如下图.
   *  或者将 SW3[2 3 4 6 7] 和 SW4[5 8] (kaluga 1.3: T1, T2, T3, T5, T6，T11, T14)关闭（ OFF ）.
-<div align="left"><img src="../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_touch_1.jpg" width = "650" alt="image 1-1" align=center /></div>
+<div align="left"><img src="../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_touch_1.jpg" width = "650" alt="image 1-1" align=center /></div>
 
 2. 将 GPIO45 上预留的两个管脚短接，如下图：
-<div align="left"><img src="../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_touch_2.jpg" width = "650" alt="image 1-2" align=center /></div>
+<div align="left"><img src="../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_touch_2.jpg" width = "650" alt="image 1-2" align=center /></div>
 
 3. 将触摸板接入主板中。如下图：
 
-<div align="left"><img src="../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_touch_3.jpg" width = "650" alt="image 1-3" align=center /></div> </br></br>
+<div align="left"><img src="../../../../docs/_static/esp32-s2-kaluga-1/kaluga_examples_touch_3.jpg" width = "650" alt="image 1-3" align=center /></div> </br></br>
 
 * ESP32_S2_Kaluga-1_v1.2 & ESP32_S2_Kaluga-1_v1.3 Touch 管脚分配
 
@@ -143,5 +143,5 @@ I (469) Touch pad: touch pad [4] base 15530, thresh 155
 ## 2 附录
 
 * [ESP32-S2 技术规格书](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_cn.pdf)
-* [ESP32-S2-Kaluga-1 主板](../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP32-S2-KALUGA-1_V1_2_20200325A.pdf)
-* [ESP-LyraP-TOUCHA 触摸板](../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP-LYRAP-TOUCHA_V1.1_20200325A.pdf)
+* [ESP32-S2-Kaluga-1 主板](../../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP32-S2-KALUGA-1_V1_2_20200325A.pdf)
+* [ESP-LyraP-TOUCHA 触摸板](../../../../docs/_static/esp32-s2-kaluga-1/schematics/SCH_ESP-LYRAP-TOUCHA_V1.1_20200325A.pdf)