docs: modify examples idf version support

imabas · Mar 7, 2022 · 92c3018 · 92c3018
1 parent 2dffa85
commit 92c3018
Show file tree

Hide file tree

Showing 104 changed files with 124 additions and 103 deletions.
diff --git a/docs/ADF_TEMPLATE_EXAMPLE_README_EN.md b/docs/ADF_TEMPLATE_EXAMPLE_README_EN.md
@@ -84,7 +84,7 @@ _List all the hardware, such as development boards, speakers, microSD card, LCD
 
 _Select either of the two expressions below depending on the actual situation._
 
-This example supports IDF release/v[x.y] and later branches. By default, it runs on ADF's build-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v[x.y] and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 This example supports IDF release/v[x.y] and later branches. By default, it runs on IDF release/v[x.y].
 
@@ -190,4 +190,4 @@ Please use the following feedback channels:
 - For technical queries, go to the [esp32.com](https://esp32.com/viewforum.php?f=20) forum
 - For a feature request or bug report, create a [GitHub issue](https://github.com/espressif/esp-adf/issues)
 
-We will get back to you as soon as possible.
+We will get back to you as soon as possible.
diff --git a/examples/advanced_examples/algorithm/README.md b/examples/advanced_examples/algorithm/README.md
@@ -32,7 +32,8 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 ## Example Set Up
 
 ### Default IDF Branch
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/algorithm/README_CN.md b/examples/advanced_examples/algorithm/README_CN.md
@@ -31,7 +31,8 @@
 ## 编译和下载
 
 ### IDF 默认分支
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 
@@ -46,6 +47,7 @@
 
 
 ### 编译和下载
+
 请先编译版本并烧录到开发板上，然后运行 monitor 工具来查看串口输出 (替换 PORT 为端口名称)：
 
 ```

diff --git a/examples/advanced_examples/dlna/README.md b/examples/advanced_examples/dlna/README.md
@@ -21,7 +21,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 ## Build and Flash
 
 ### Default IDF Branch
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/dlna/README_CN.md b/examples/advanced_examples/dlna/README_CN.md
@@ -21,7 +21,8 @@
 ## 编译和下载
 
 ### IDF 默认分支
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/advanced_examples/downmix_pipeline/README.md b/examples/advanced_examples/downmix_pipeline/README.md
@@ -55,7 +55,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 ## Example Set Up
 
 ### Default IDF Branch
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/downmix_pipeline/README_CN.md b/examples/advanced_examples/downmix_pipeline/README_CN.md
@@ -56,7 +56,8 @@ mp3 new come input stream ---> resample ---
 ## 编译和下载
 
 ### IDF 默认分支
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/advanced_examples/esp_dispatcher_dueros/README.md b/examples/advanced_examples/esp_dispatcher_dueros/README.md
@@ -20,7 +20,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/esp_dispatcher_dueros/README_CN.md b/examples/advanced_examples/esp_dispatcher_dueros/README_CN.md
@@ -20,7 +20,7 @@
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/advanced_examples/flexible_pipeline/README.md b/examples/advanced_examples/flexible_pipeline/README.md
@@ -32,7 +32,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/flexible_pipeline/README_CN.md b/examples/advanced_examples/flexible_pipeline/README_CN.md
@@ -31,7 +31,7 @@
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/advanced_examples/http_play_and_save_to_file/README.md b/examples/advanced_examples/http_play_and_save_to_file/README.md
@@ -30,7 +30,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 ## Example Set Up
 
 ### Default IDF Branch
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/http_play_and_save_to_file/README_CN.md b/examples/advanced_examples/http_play_and_save_to_file/README_CN.md
@@ -34,7 +34,7 @@ http_stream_reader ---> mp3_decoder ---> i2s_stream ---> codec chip
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/advanced_examples/multi-room/README_CN.md b/examples/advanced_examples/multi-room/README_CN.md
@@ -25,7 +25,8 @@ ESP Multi-Room Music 是一种基于 Wi-Fi 的多扬声器互联共享音乐通
 
 ### 使用 IDF 其他分支
 
-此示例需要选择 IDF `release/v4.2` 以上的分支来编译。
+本例程支持 IDF release/v4.2 及以后的分支，例程默认使用 IDF release/v4.4 分支。
+
 ```c
 cd $IDF_PATH
 git checkout master

diff --git a/examples/advanced_examples/nvs_dispatcher/README.md b/examples/advanced_examples/nvs_dispatcher/README.md
@@ -23,7 +23,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/nvs_dispatcher/README_CN.md b/examples/advanced_examples/nvs_dispatcher/README_CN.md
@@ -22,7 +22,7 @@ ADF 在外部 PSRAM 中创建和使用了较多堆栈任务，任务运行时候
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/advanced_examples/record_while_play/README.md b/examples/advanced_examples/record_while_play/README.md
@@ -39,7 +39,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/record_while_play/README_CN.md b/examples/advanced_examples/record_while_play/README_CN.md
@@ -38,7 +38,7 @@
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/advanced_examples/voip/README.md b/examples/advanced_examples/voip/README.md
@@ -57,7 +57,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/advanced_examples/voip/README_CN.md b/examples/advanced_examples/voip/README_CN.md
@@ -59,7 +59,7 @@ ESP32-LyraT-Mini：
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/audio_processing/pipeline_alc/README.md b/examples/audio_processing/pipeline_alc/README.md
@@ -35,7 +35,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 
 ### Configuration

diff --git a/examples/audio_processing/pipeline_alc/README_CN.md b/examples/audio_processing/pipeline_alc/README_CN.md
@@ -34,7 +34,7 @@ ADF 当前提供了以下两种方法实现 ALC 设置音量。
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 
 ### 配置

diff --git a/examples/audio_processing/pipeline_audio_forge/README.md b/examples/audio_processing/pipeline_audio_forge/README.md
@@ -42,7 +42,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/audio_processing/pipeline_audio_forge/README_CN.md b/examples/audio_processing/pipeline_audio_forge/README_CN.md
@@ -42,7 +42,7 @@
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/audio_processing/pipeline_equalizer/README.md b/examples/audio_processing/pipeline_equalizer/README.md
@@ -28,7 +28,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 
 ### Configuration

diff --git a/examples/audio_processing/pipeline_equalizer/README_CN.md b/examples/audio_processing/pipeline_equalizer/README_CN.md
@@ -28,7 +28,7 @@ sdcard ---> fatfs_stream ---> wav_decoder ---> equalizer ---> i2s_stream ---> co
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 
 ### 配置

diff --git a/examples/audio_processing/pipeline_passthru/README.md b/examples/audio_processing/pipeline_passthru/README.md
@@ -33,7 +33,8 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 ## Build and Flash
 
 ### Default IDF Branch
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/audio_processing/pipeline_passthru/README_CN.md b/examples/audio_processing/pipeline_passthru/README_CN.md
@@ -33,7 +33,8 @@
 ## 编译和下载
 
 ### IDF 默认分支
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/audio_processing/pipeline_resample/README.md b/examples/audio_processing/pipeline_resample/README.md
@@ -49,7 +49,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 
 ### Configuration

diff --git a/examples/audio_processing/pipeline_resample/README_CN.md b/examples/audio_processing/pipeline_resample/README_CN.md
@@ -50,7 +50,7 @@
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 
 ### 配置

diff --git a/examples/audio_processing/pipeline_sonic/README.md b/examples/audio_processing/pipeline_sonic/README.md
@@ -38,7 +38,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 ## Build and Flash
 
 ### Default IDF Branch
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 
 ### Configuration

diff --git a/examples/audio_processing/pipeline_sonic/README_CN.md b/examples/audio_processing/pipeline_sonic/README_CN.md
@@ -38,7 +38,8 @@
 ## 编译和下载
 
 ### IDF 默认分支
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 
 ### 配置

diff --git a/examples/audio_processing/pipeline_spiffs_amr_resample/README.md b/examples/audio_processing/pipeline_spiffs_amr_resample/README.md
@@ -45,7 +45,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration
 

diff --git a/examples/audio_processing/pipeline_spiffs_amr_resample/README_CN.md b/examples/audio_processing/pipeline_spiffs_amr_resample/README_CN.md
@@ -46,7 +46,7 @@
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/checks/check_board_buttons/README.md b/examples/checks/check_board_buttons/README.md
@@ -24,7 +24,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 
 ### Configuration

diff --git a/examples/checks/check_board_buttons/README_CN.md b/examples/checks/check_board_buttons/README_CN.md
@@ -24,7 +24,7 @@ ADF 定义了音频开发板常用的 [6 种功能按键](https://github.com/esp
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 
 ### 配置

diff --git a/examples/checks/check_display_led/README.md b/examples/checks/check_display_led/README.md
@@ -23,7 +23,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 
 ### Configuration

diff --git a/examples/checks/check_display_led/README_CN.md b/examples/checks/check_display_led/README_CN.md
@@ -21,7 +21,7 @@ ADF 从功能角度为定义了一系列常见的 [显示模式](https://github.
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 ### 配置
 

diff --git a/examples/cli/README.md b/examples/cli/README.md
@@ -54,7 +54,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 
 ### Configuration

diff --git a/examples/cli/README_CN.md b/examples/cli/README_CN.md
@@ -54,7 +54,7 @@
 
 ### IDF 默认分支
 
-本例程默认 IDF 为 ADF 的內建分支 `$ADF_PATH/esp-idf`。
+本例程支持 IDF release/v3.3 及以后的分支，例程默认使用 ADF 的內建分支 `$ADF_PATH/esp-idf`。
 
 
 ### 配置

diff --git a/examples/cloud_services/pipeline_aws_polly_mp3/README.md b/examples/cloud_services/pipeline_aws_polly_mp3/README.md
@@ -26,7 +26,7 @@ This example runs on the boards that are marked with a green checkbox in the [ta
 
 ### Default IDF Branch
 
-The default IDF branch of this example is ADF's built-in branch `$ADF_PATH/esp-idf`.
+This example supports IDF release/v3.3 and later branches. By default, it runs on ADF's built-in branch `$ADF_PATH/esp-idf`.
 
 ### Configuration