From ebbf7dec74e9aad505f3dfb32897d1a92d7370e9 Mon Sep 17 00:00:00 2001 From: Kondal Kolipaka Date: Wed, 12 Jun 2024 16:08:43 +0530 Subject: [PATCH] fix: move docs to docs_readme (#985) Will use docs folder for publishing to docs.espressif.com --- README.md | 106 +++++++++--------- README_CN.md | 104 ++++++++--------- .../Espressif-IDE-Windows-Installer.md | 0 {docs => docs_readme}/Espressif-IDE.md | 2 +- {docs => docs_readme}/HeapTracing.md | 0 {docs => docs_readme}/JTAG Flashing.md | 0 .../MissingToolsManualPathUpdateGuide.md | 0 {docs => docs_readme}/OpenOCD Debugging.md | 2 +- {docs => docs_readme}/clangd_cdt_support.md | 0 .../images/10_serial_terminal.png | Bin .../images/11_launch_configuration.png | Bin {docs => docs_readme}/images/12_flashing.png | Bin .../images/13_sdkconfig_editor.png | Bin .../images/1_idffeature_install.png | Bin .../images/2_environment_pref.png | Bin .../images/3_new_project_default.png | Bin .../images/4_new_project_templates.png | Bin .../images/5_import_project.png | Bin .../images/6_core_build_toolchains.png | Bin .../images/7_cmake_toolchain.png | Bin .../images/8_launch_target.png | Bin .../images/9_cmake_build.png | Bin .../images/AppLvlTracing_1.png | Bin .../images/AppLvlTracing_2.png | Bin .../images/AppLvlTracing_3.png | Bin .../images/AppLvlTracing_4.png | Bin .../images/AppLvlTracing_5.png | Bin .../images/CDT_Build_Console.png | Bin .../CoreDumpDebugging/sdkconfig_editor.png | Bin .../ESP-IDF_Components/components_window.png | Bin .../ESP-IDF_Components/install_components.png | Bin .../images/GDBStubDebugging/code_example.png | Bin .../GDBStubDebugging/debug_panic_mode.png | Bin .../GDBStubDebugging/sdkconfig_editor.png | Bin .../sdkconfig_editor_panic_behavior.png | Bin .../HeapTracing/analysis_context_menu.png | Bin .../breakpoint_properties_actions.png | Bin ...oint_properties_actions_start_attached.png | Bin ...point_properties_actions_stop_attached.png | Bin .../breakpoint_properties_popup.png | Bin .../images/HeapTracing/callers_view.png | Bin .../HeapTracing/details_tab_tracing.png | Bin .../HeapTracing/heap_tracing_action.png | Bin .../HeapTracing/overview_tab_tracing.png | Bin .../overview_tab_tracing_contexts.png | Bin .../HeapTracing/show_callers_context_menu.png | Bin .../HeapTracing/sysview_heap_log_file.PNG | Bin .../images/IDF_tools_console.png | Bin {docs => docs_readme}/images/JtagFlash_1.png | Bin {docs => docs_readme}/images/JtagFlash_2.png | Bin {docs => docs_readme}/images/JtagFlash_3.png | Bin .../images/OpenOCDDebug_1.png | Bin .../images/OpenOCDDebug_10.png | Bin .../images/OpenOCDDebug_11.png | Bin .../images/OpenOCDDebug_12.png | Bin .../images/OpenOCDDebug_13.png | Bin .../images/OpenOCDDebug_2.png | Bin .../images/OpenOCDDebug_3.png | Bin .../images/OpenOCDDebug_4.png | Bin .../images/OpenOCDDebug_5.png | Bin .../images/OpenOCDDebug_6.png | Bin .../images/OpenOCDDebug_7.png | Bin .../images/OpenOCDDebug_8.png | Bin .../images/OpenOCDDebug_9.png | Bin .../images/Preference_recorder.png | Bin ..._Configuration_Download_or_Use_ESP-IDF.png | Bin .../ESP-IDF_Manager_Editor_Screen.png | Bin .../ESP-IDF_Manager_Multiple_versions.png | Bin .../Tool_installed_and_activated.png | Bin .../images/ToolsValidation/EnvSettings.png | Bin .../images/ToolsValidation/PathVarEdit.png | Bin .../images/ToolsValidation/PathVarEdited.png | Bin .../images/Update_plugins.png | Bin .../images/buildconfiguration_clang.png | Bin .../images/change_language.png | Bin .../images/cland_starting.png | Bin .../images/clangd/build_settings_clang.png | Bin .../images/clangd/cdt_indexer_disable.png | Bin .../images/clangd/cdtlsp_updatesite.png | Bin .../images/clangd/clang_compiler_config.png | Bin .../images/clangd/clangd_config.png | Bin .../images/clangd/clangd_context_help.png | Bin .../images/clangd/clangd_editor.png | Bin .../new_cmake_clang_toolchain_config.png | Bin .../images/clangd_consolelog_config.png | Bin .../images/clangd_generic_editor.png | Bin .../images/clangd_preference.png | Bin .../images/clangd_proposals.png | Bin .../images/clangd_updatesite.png | Bin .../images/cmake_editor_ca.png | Bin .../images/cmake_editor_preferences.png | Bin .../images/code_analysis_disable_symbols.png | Bin .../images/custombuilddir.png | Bin .../images/espressifide_splash.bmp | Bin {docs => docs_readme}/images/export_log.png | Bin {docs => docs_readme}/images/icons/build.png | Bin {docs => docs_readme}/images/icons/debug.png | Bin {docs => docs_readme}/images/icons/delete.png | Bin {docs => docs_readme}/images/icons/run.png | Bin .../images/icons/terminate.png | Bin {docs => docs_readme}/images/idf_terminal.png | Bin .../images/idf_update_site_install.png | Bin {docs => docs_readme}/images/linux-logo.png | Bin {docs => docs_readme}/images/macos-logo.png | Bin {docs => docs_readme}/images/market_place.png | Bin .../images/sizeanalysis_details.png | Bin .../images/sizeanalysis_overview.png | Bin .../ide_windows_installer_0.png | Bin .../ide_windows_installer_1.png | Bin .../ide_windows_installer_10.png | Bin .../ide_windows_installer_11.png | Bin .../ide_windows_installer_12.png | Bin .../ide_windows_installer_13.png | Bin .../ide_windows_installer_14.png | Bin .../ide_windows_installer_2.png | Bin .../ide_windows_installer_3.png | Bin .../ide_windows_installer_4.png | Bin .../ide_windows_installer_5.png | Bin .../ide_windows_installer_6.png | Bin .../ide_windows_installer_7.png | Bin .../ide_windows_installer_8.png | Bin .../ide_windows_installer_9.png | Bin {docs => docs_readme}/images/windows-logo.png | Bin .../images/zh/10_serial_terminal.png | Bin .../images/zh/11_launch_configuration.png | Bin .../images/zh/1_idffeature_install.png | Bin .../images/zh/2_environment_pref.png | Bin .../images/zh/3_new_project_default.png | Bin .../images/zh/4_new_project_templates.png | Bin .../images/zh/5_import_project.png | Bin .../images/zh/8_launch_target.png | Bin .../ESP-IDF_Components/components_window.png | Bin .../ESP-IDF_Components/install_components.png | Bin .../zh/GDBStubDebugging/code_example.png | Bin .../zh/GDBStubDebugging/debug_panic_mode.png | Bin .../zh/GDBStubDebugging/sdkconfig_editor.png | Bin .../sdkconfig_editor_panic_behavior.png | Bin .../zh/HeapTracing/analysis_context_menu.png | Bin .../breakpoint_properties_actions.png | Bin ...oint_properties_actions_start_attached.png | Bin ...point_properties_actions_stop_attached.png | Bin .../breakpoint_properties_popup.png | Bin .../images/zh/HeapTracing/callers_view.png | Bin .../zh/HeapTracing/details_tab_tracing.png | Bin .../zh/HeapTracing/heap_tracing_action.png | Bin .../zh/HeapTracing/overview_tab_tracing.png | Bin .../overview_tab_tracing_contexts.png | Bin .../HeapTracing/show_callers_context_menu.png | Bin .../zh/HeapTracing/sysview_heap_log_file.PNG | Bin .../images/zh/IDF_tools_console.png | Bin .../zh/ToolsManager/git_python_selection.png | Bin .../zh/ToolsManager/install_tools_manager.png | Bin .../manage_tools_installation.png | Bin .../select_or_download_new_esp_idf.png | Bin .../images/zh/change_language.png | Bin .../images/zh/cmake_editor_preferences.png | Bin .../images/zh/esp_idf_dir.png | Bin .../images/zh/espidf_download.png | Bin .../images/zh/export_log.png | Bin .../images/zh/idf_terminal.png | Bin .../images/zh/idf_update_site_install.png | Bin .../images/zh/sizeanalysis_details.png | Bin .../images/zh/sizeanalysis_overview.png | Bin 163 files changed, 107 insertions(+), 107 deletions(-) rename {docs => docs_readme}/Espressif-IDE-Windows-Installer.md (100%) rename {docs => docs_readme}/Espressif-IDE.md (97%) rename {docs => docs_readme}/HeapTracing.md (100%) rename {docs => docs_readme}/JTAG Flashing.md (100%) rename {docs => docs_readme}/MissingToolsManualPathUpdateGuide.md (100%) rename {docs => docs_readme}/OpenOCD Debugging.md (98%) rename {docs => docs_readme}/clangd_cdt_support.md (100%) rename {docs => docs_readme}/images/10_serial_terminal.png (100%) rename {docs => docs_readme}/images/11_launch_configuration.png (100%) rename {docs => docs_readme}/images/12_flashing.png (100%) rename {docs => docs_readme}/images/13_sdkconfig_editor.png (100%) rename {docs => docs_readme}/images/1_idffeature_install.png (100%) rename {docs => docs_readme}/images/2_environment_pref.png (100%) rename {docs => docs_readme}/images/3_new_project_default.png (100%) rename {docs => docs_readme}/images/4_new_project_templates.png (100%) rename {docs => docs_readme}/images/5_import_project.png (100%) rename {docs => docs_readme}/images/6_core_build_toolchains.png (100%) rename {docs => docs_readme}/images/7_cmake_toolchain.png (100%) rename {docs => docs_readme}/images/8_launch_target.png (100%) rename {docs => docs_readme}/images/9_cmake_build.png (100%) rename {docs => docs_readme}/images/AppLvlTracing_1.png (100%) rename {docs => docs_readme}/images/AppLvlTracing_2.png (100%) rename {docs => docs_readme}/images/AppLvlTracing_3.png (100%) rename {docs => docs_readme}/images/AppLvlTracing_4.png (100%) rename {docs => docs_readme}/images/AppLvlTracing_5.png (100%) rename {docs => docs_readme}/images/CDT_Build_Console.png (100%) rename {docs => docs_readme}/images/CoreDumpDebugging/sdkconfig_editor.png (100%) rename {docs => docs_readme}/images/ESP-IDF_Components/components_window.png (100%) rename {docs => docs_readme}/images/ESP-IDF_Components/install_components.png (100%) rename {docs => docs_readme}/images/GDBStubDebugging/code_example.png (100%) rename {docs => docs_readme}/images/GDBStubDebugging/debug_panic_mode.png (100%) rename {docs => docs_readme}/images/GDBStubDebugging/sdkconfig_editor.png (100%) rename {docs => docs_readme}/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png (100%) rename {docs => docs_readme}/images/HeapTracing/analysis_context_menu.png (100%) rename {docs => docs_readme}/images/HeapTracing/breakpoint_properties_actions.png (100%) rename {docs => docs_readme}/images/HeapTracing/breakpoint_properties_actions_start_attached.png (100%) rename {docs => docs_readme}/images/HeapTracing/breakpoint_properties_actions_stop_attached.png (100%) rename {docs => docs_readme}/images/HeapTracing/breakpoint_properties_popup.png (100%) rename {docs => docs_readme}/images/HeapTracing/callers_view.png (100%) rename {docs => docs_readme}/images/HeapTracing/details_tab_tracing.png (100%) rename {docs => docs_readme}/images/HeapTracing/heap_tracing_action.png (100%) rename {docs => docs_readme}/images/HeapTracing/overview_tab_tracing.png (100%) rename {docs => docs_readme}/images/HeapTracing/overview_tab_tracing_contexts.png (100%) rename {docs => docs_readme}/images/HeapTracing/show_callers_context_menu.png (100%) rename {docs => docs_readme}/images/HeapTracing/sysview_heap_log_file.PNG (100%) rename {docs => docs_readme}/images/IDF_tools_console.png (100%) rename {docs => docs_readme}/images/JtagFlash_1.png (100%) rename {docs => docs_readme}/images/JtagFlash_2.png (100%) rename {docs => docs_readme}/images/JtagFlash_3.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_1.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_10.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_11.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_12.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_13.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_2.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_3.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_4.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_5.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_6.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_7.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_8.png (100%) rename {docs => docs_readme}/images/OpenOCDDebug_9.png (100%) rename {docs => docs_readme}/images/Preference_recorder.png (100%) rename {docs => docs_readme}/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png (100%) rename {docs => docs_readme}/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png (100%) rename {docs => docs_readme}/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png (100%) rename {docs => docs_readme}/images/ToolsManager/Tool_installed_and_activated.png (100%) rename {docs => docs_readme}/images/ToolsValidation/EnvSettings.png (100%) rename {docs => docs_readme}/images/ToolsValidation/PathVarEdit.png (100%) rename {docs => docs_readme}/images/ToolsValidation/PathVarEdited.png (100%) rename {docs => docs_readme}/images/Update_plugins.png (100%) rename {docs => docs_readme}/images/buildconfiguration_clang.png (100%) rename {docs => docs_readme}/images/change_language.png (100%) rename {docs => docs_readme}/images/cland_starting.png (100%) rename {docs => docs_readme}/images/clangd/build_settings_clang.png (100%) rename {docs => docs_readme}/images/clangd/cdt_indexer_disable.png (100%) rename {docs => docs_readme}/images/clangd/cdtlsp_updatesite.png (100%) rename {docs => docs_readme}/images/clangd/clang_compiler_config.png (100%) rename {docs => docs_readme}/images/clangd/clangd_config.png (100%) rename {docs => docs_readme}/images/clangd/clangd_context_help.png (100%) rename {docs => docs_readme}/images/clangd/clangd_editor.png (100%) rename {docs => docs_readme}/images/clangd/new_cmake_clang_toolchain_config.png (100%) rename {docs => docs_readme}/images/clangd_consolelog_config.png (100%) rename {docs => docs_readme}/images/clangd_generic_editor.png (100%) rename {docs => docs_readme}/images/clangd_preference.png (100%) rename {docs => docs_readme}/images/clangd_proposals.png (100%) rename {docs => docs_readme}/images/clangd_updatesite.png (100%) rename {docs => docs_readme}/images/cmake_editor_ca.png (100%) rename {docs => docs_readme}/images/cmake_editor_preferences.png (100%) rename {docs => docs_readme}/images/code_analysis_disable_symbols.png (100%) rename {docs => docs_readme}/images/custombuilddir.png (100%) rename {docs => docs_readme}/images/espressifide_splash.bmp (100%) rename {docs => docs_readme}/images/export_log.png (100%) rename {docs => docs_readme}/images/icons/build.png (100%) rename {docs => docs_readme}/images/icons/debug.png (100%) rename {docs => docs_readme}/images/icons/delete.png (100%) rename {docs => docs_readme}/images/icons/run.png (100%) rename {docs => docs_readme}/images/icons/terminate.png (100%) rename {docs => docs_readme}/images/idf_terminal.png (100%) rename {docs => docs_readme}/images/idf_update_site_install.png (100%) rename {docs => docs_readme}/images/linux-logo.png (100%) rename {docs => docs_readme}/images/macos-logo.png (100%) rename {docs => docs_readme}/images/market_place.png (100%) rename {docs => docs_readme}/images/sizeanalysis_details.png (100%) rename {docs => docs_readme}/images/sizeanalysis_overview.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_0.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_1.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_10.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_11.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_12.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_13.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_14.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_2.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_3.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_4.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_5.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_6.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_7.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_8.png (100%) rename {docs => docs_readme}/images/windows-installation/ide_windows_installer_9.png (100%) rename {docs => docs_readme}/images/windows-logo.png (100%) rename {docs => docs_readme}/images/zh/10_serial_terminal.png (100%) rename {docs => docs_readme}/images/zh/11_launch_configuration.png (100%) rename {docs => docs_readme}/images/zh/1_idffeature_install.png (100%) rename {docs => docs_readme}/images/zh/2_environment_pref.png (100%) rename {docs => docs_readme}/images/zh/3_new_project_default.png (100%) rename {docs => docs_readme}/images/zh/4_new_project_templates.png (100%) rename {docs => docs_readme}/images/zh/5_import_project.png (100%) rename {docs => docs_readme}/images/zh/8_launch_target.png (100%) rename {docs => docs_readme}/images/zh/ESP-IDF_Components/components_window.png (100%) rename {docs => docs_readme}/images/zh/ESP-IDF_Components/install_components.png (100%) rename {docs => docs_readme}/images/zh/GDBStubDebugging/code_example.png (100%) rename {docs => docs_readme}/images/zh/GDBStubDebugging/debug_panic_mode.png (100%) rename {docs => docs_readme}/images/zh/GDBStubDebugging/sdkconfig_editor.png (100%) rename {docs => docs_readme}/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/analysis_context_menu.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/breakpoint_properties_actions.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/breakpoint_properties_popup.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/callers_view.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/details_tab_tracing.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/heap_tracing_action.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/overview_tab_tracing.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/overview_tab_tracing_contexts.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/show_callers_context_menu.png (100%) rename {docs => docs_readme}/images/zh/HeapTracing/sysview_heap_log_file.PNG (100%) rename {docs => docs_readme}/images/zh/IDF_tools_console.png (100%) rename {docs => docs_readme}/images/zh/ToolsManager/git_python_selection.png (100%) rename {docs => docs_readme}/images/zh/ToolsManager/install_tools_manager.png (100%) rename {docs => docs_readme}/images/zh/ToolsManager/manage_tools_installation.png (100%) rename {docs => docs_readme}/images/zh/ToolsManager/select_or_download_new_esp_idf.png (100%) rename {docs => docs_readme}/images/zh/change_language.png (100%) rename {docs => docs_readme}/images/zh/cmake_editor_preferences.png (100%) rename {docs => docs_readme}/images/zh/esp_idf_dir.png (100%) rename {docs => docs_readme}/images/zh/espidf_download.png (100%) rename {docs => docs_readme}/images/zh/export_log.png (100%) rename {docs => docs_readme}/images/zh/idf_terminal.png (100%) rename {docs => docs_readme}/images/zh/idf_update_site_install.png (100%) rename {docs => docs_readme}/images/zh/sizeanalysis_details.png (100%) rename {docs => docs_readme}/images/zh/sizeanalysis_overview.png (100%) diff --git a/README.md b/README.md index 046e97ae2..171403b61 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ It provides better tooling capabilities, which simplifies and enhances standard The plug-in runs on `macOS`, `Windows` and `Linux` platforms. -![](docs/images/macos-logo.png) -![](docs/images/windows-logo.png) -![](docs/images/linux-logo.png) +![](docs_readme/images/macos-logo.png) +![](docs_readme/images/windows-logo.png) +![](docs_readme/images/linux-logo.png) > **Note:** It supports ESP-IDF CMake based projects (4.x and above). @@ -68,10 +68,10 @@ To get a quick understanding of ESP-IDF and Eclipse plugin features, check our s We recommend using the Espressif-IDE instead of the Eclipse CDT + IEP Plugin update approach to avoid the hassles of updating. ## Espressif-IDE for Windows -* Download the [Espressif-IDE with ESP-IDF Offline Windows Installer](https://dl.espressif.com/dl/esp-idf/) and follow the instructions provided [here](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/Espressif-IDE-Windows-Installer.md). This guide will walk you through the installation process for Java, Git, CMake, ESP-IDF, IDF Tools, Device Drivers, and Espressif-IDE to help you get started. +* Download the [Espressif-IDE with ESP-IDF Offline Windows Installer](https://dl.espressif.com/dl/esp-idf/) and follow the instructions provided [here](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE-Windows-Installer.md). This guide will walk you through the installation process for Java, Git, CMake, ESP-IDF, IDF Tools, Device Drivers, and Espressif-IDE to help you get started. ## Espressif-IDE for macOS and Linux -* To begin, download the [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/Espressif-IDE.md#downloads) for your respective operating system. Following this, launch the IDE and proceed to install the necessary ESP-IDF and related tools. Please note that prior to launching the IDE, you must ensure that Java, Python, and Git are installed as [prerequisites](#Prerequisites). and available in the system path. +* To begin, download the [Espressif-IDE](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE.md#downloads) for your respective operating system. Following this, launch the IDE and proceed to install the necessary ESP-IDF and related tools. Please note that prior to launching the IDE, you must ensure that Java, Python, and Git are installed as [prerequisites](#Prerequisites). and available in the system path. If you plan to use Eclipse CDT and update it through the IDF Eclipse plugin, please ensure that you download the supported version for your operating system from here . @@ -105,7 +105,7 @@ For adding beta and nightly builds, you can use the following update site urls. > **Note:** While the screenshots are captured on macOS, the installation instructions are applicable to Windows, Linux, and macOS. -![](docs/images/idf_update_site_install.png) +![](docs_readme/images/idf_update_site_install.png) # Installing ESP-IDF @@ -113,10 +113,10 @@ For adding beta and nightly builds, you can use the following update site urls. Please follow the instructions below for installing ESP-IDF in the Espressif-IDE. 1. Go to `Espressif` > `ESP-IDF Manager`. The following editor will open -![](docs/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png) +![](docs_readme/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png) 1. Click on `Add ESP-IDF` button. -![](docs/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png) +![](docs_readme/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png) From the screen shown above you can choose an already downloaded ESP-IDF Directory or you can select and download directly from the given dialog. The `Git` and `Python` must be installed and if it is configured in system PATH it will be preloaded in the given view. If not you can Browse to the directory and select the proper executables. 1. Click on `Finish` which will be enabled after all the paths and executables are properly configured. @@ -125,12 +125,12 @@ From the screen shown above you can choose an already downloaded ESP-IDF Directo To configure an existing ESP-IDF: After you have clicked `Finish` you will see the progress on console for the tools getting installed. Once the installation is done and this is the very first set of ESP-IDF installed in the IDE it will be activated as well and you will see a similar entry in the editor for ESP-IDF Manager -![](docs/images/ToolsManager/Tool_installed_and_activated.png) +![](docs_readme/images/ToolsManager/Tool_installed_and_activated.png) You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. Lets take a look at how the multiple versions will look like. You have to follow the same steps as done previously to add another ESP-IDF version to the IDE. -![](docs/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png) +![](docs_readme/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png) To activate any specific version simply click on the radio button next to it in the `Active` column. @@ -150,7 +150,7 @@ To create a project using existing ESP-IDF templates, please refer to [this](#Ne > **Note:** You may see numerous unresolved headers and symbols errors in the editor, and these will only be resolved after the build process. -![](docs/images/3_new_project_default.png) +![](docs_readme/images/3_new_project_default.png) # Configuring build target @@ -165,7 +165,7 @@ However, if you would like to add a target that is not available in the launch t 1. Select `ESP Target`. 1. Provide properties for the target where you would like to launch the application. Enter a `Name` for the target and select the `Serial Port` your ESP device is connected to on your machine. -![](docs/images/8_launch_target.png) +![](docs_readme/images/8_launch_target.png) # Compiling the Project @@ -174,20 +174,20 @@ However, if you would like to add a target that is not available in the launch t 1. Select `Run` from the first drop-down, which is called `Launch Mode`. 1. Select your application from the second drop-down, which is called `Launch Configuration`(Auto-detected). 1. Select a target from the third drop-down, which is called `Launch Target`. -1. Now click on the `Build` ![](docs/images/icons/build.png) button to start with a build process. +1. Now click on the `Build` ![](docs_readme/images/icons/build.png) button to start with a build process. -![](docs/images/9_cmake_build.png) +![](docs_readme/images/9_cmake_build.png) # Flashing the Project -Flash operation can be initiated with just a click of a launch button ![](docs/images/icons/run.png) and it's auto-configured to flash the application with the default flash command i.e, `idf.py -p PORT flash`. +Flash operation can be initiated with just a click of a launch button ![](docs_readme/images/icons/run.png) and it's auto-configured to flash the application with the default flash command i.e, `idf.py -p PORT flash`. flash To provide the customized flash arguments, please follow [this](#customizeLaunchConfig) link for further instructions. -To configure flashing via JTAG, please refer to this JTAG Flashing guide. +To configure flashing via JTAG, please refer to this JTAG Flashing guide. # Viewing Serial Output @@ -202,7 +202,7 @@ To see the serial output in Eclipse, we need to configure the `ESP-IDF Serial Mo 1. Configure serial monitor filter options for output filtering. 1. Click on `OK` to launch the terminal, which will listen to the USB port. -![](docs/images/10_serial_terminal.png) +![](docs_readme/images/10_serial_terminal.png) ### ESP-IDF Serial Monitor Settings @@ -221,12 +221,12 @@ In most cases, only two things are required to start debugging an esp-idf projec The fastest way to create a debug configuration is to expand the configuration list in the launch bar and click `New Launch Configuration...`. Then select `ESP-IDF GDB OpenOCD Debugging` -> Double Click or `Next`. After that, the preview for the new debug configuration will open where it's necessary to check the board. -After creating the debug configuration, you can go ahead and debug the project. Select the configuration you just created, select debug mode, and click on the "Debug" icon ![](docs/images/icons/debug.png) to start debugging: +After creating the debug configuration, you can go ahead and debug the project. Select the configuration you just created, select debug mode, and click on the "Debug" icon ![](docs_readme/images/icons/debug.png) to start debugging: ![Debugging_process](https://github.com/espressif/idf-eclipse-plugin/assets/24419842/1fb0fb9b-a02a-4ed1-bdba-b4b4d36d100f) -To learn more about the debug configuration, please refer to GDB OpenOCD Debugging. +To learn more about the debug configuration, please refer to GDB OpenOCD Debugging. # Other IDE Features @@ -243,7 +243,7 @@ To learn more about the debug configuration, please refer to @@ -258,18 +258,18 @@ To launch the SDK Configuration editor: 1. Use `Ctrl+S` or `Command+S` based on the OS environment to save the changes. You can also use Eclipse `Save` button from the toolbar. 1. To revert the sdkconfig editor changes, you can either close the editor without saving them or you can right-click on the `sdkconfig` file and select `Load sdkconfig` menu option to revert the changes from the editor. -![](docs/images/13_sdkconfig_editor.png) +![](docs_readme/images/13_sdkconfig_editor.png) # CMake Editor CMake Editor Plug-in is integrated with IDF Plugin for editing CMake files such as CMakeLists.txt. It provides syntax coloring, CMake command content assist, and code templates. -![](docs/images/cmake_editor_ca.png) +![](docs_readme/images/cmake_editor_ca.png) CMake editor preferences can be controlled using `Eclipse` > `Preferences` > `CMakeEd`. -![](docs/images/cmake_editor_preferences.png) +![](docs_readme/images/cmake_editor_preferences.png) # ESP-IDF Application Size Analysis @@ -287,11 +287,11 @@ To launch the Application Size Analysis editor: **Application Size Analysis - Overview** -![](docs/images/sizeanalysis_overview.png) +![](docs_readme/images/sizeanalysis_overview.png) **Application Size Analysis - Details** -![](docs/images/sizeanalysis_details.png) +![](docs_readme/images/sizeanalysis_details.png) # ESP-IDF Terminal @@ -305,7 +305,7 @@ To launch the ESP-IDF Terminal: * Click on the `Open a Terminal` icon from the toolbar. * Choose `ESP-IDF Terminal` from the terminal drop-down and click `OK` to launch a terminal. -![](docs/images/idf_terminal.png) +![](docs_readme/images/idf_terminal.png) # Installing ESP-IDF Components @@ -314,12 +314,12 @@ You can install the ESP-IDF Components directly into your project from the avail * Right-click on the project from `Project Explorer` in which you want to add the component to and Select `Install ESP-IDF Components`. - ![](docs/images/ESP-IDF_Components/install_components.png) + ![](docs_readme/images/ESP-IDF_Components/install_components.png) A new window will open up showing all the available component to be installed. * From the window, you can click on `Install` button to add that component to the project. To get to the readme file for that component you can click on `More Info` which will open the browser link to the readme file of that component. - ![](docs/images/ESP-IDF_Components/components_window.png) + ![](docs_readme/images/ESP-IDF_Components/components_window.png) Already added components are also shown but the `Install` button changes text to `Already Added` and is disabled. @@ -328,7 +328,7 @@ Already added components are also shown but the `Install` button changes text to All the required environment variables are automatically configured by the IDE during the ESP-IDF and Tools installation process (Espressif > ESP-IDF Manager > Add ESP-IDF). You can verify them in the Preferences page under `C/C++` > `Build` > `Environment`. -![](docs/images/2_environment_pref.png) +![](docs_readme/images/2_environment_pref.png) # Configuring Toolchains @@ -350,7 +350,7 @@ If these toolchains are not detected for any reason, please follow the step-by-s * **Operating System:** esp32, * **CPU Architecture:** xtensa -![](docs/images/6_core_build_toolchains.png) +![](docs_readme/images/6_core_build_toolchains.png) # Configuring CMake Toolchain @@ -364,7 +364,7 @@ We now need to tell CDT which toolchain to use when building the project. This w > **Note:** Eclipse CDT has a bug in saving the toolchain preferences, hence it's recommended to restart Eclipse before we move further configuring the launch target. -![](docs/images/7_cmake_toolchain.png) +![](docs_readme/images/7_cmake_toolchain.png) # Selecting Clang Toolchain @@ -390,9 +390,9 @@ To provide the customized launch configuration and flash arguments, please follo 1. Click OK to save the settings. 1. Click on the `Launch` icon to flash the application to the selected board. -![](docs/images/11_launch_configuration.png) +![](docs_readme/images/11_launch_configuration.png) -![](docs/images/12_flashing.png) +![](docs_readme/images/12_flashing.png) # Changing Language @@ -404,7 +404,7 @@ To change the plugin language a menu is provided to show the list of available l 1. From the sub menu select the language you want. 1. IDE will restart with the selected language. -![](docs/images/change_language.png) +![](docs_readme/images/change_language.png) Remember this will only change the language of the Eclipse if the required language bundles for the selected language are installed or else only the plugin interfaces will be changed. @@ -438,7 +438,7 @@ To export the current log view content into a file, press the Export Log toolbar Always provide an error log when reporting an issue. -![](docs/images/export_log.png) +![](docs_readme/images/export_log.png) ## Console View Log @@ -446,7 +446,7 @@ The Console View provides all the warnings and errors related to the current run From the menu bar, `Window` > `Show View` > `Console`. -![](docs/images/CDT_Build_Console.png) +![](docs_readme/images/CDT_Build_Console.png) ## CDT Global Build Log @@ -460,11 +460,11 @@ If you encounter any issue while installing the IDF tools using `Espressif` > `E If this is not active, it can be switched by clicking on the `Display Selected Console` icon from the console view. -![](docs/images/IDF_tools_console.png) +![](docs_readme/images/IDF_tools_console.png) ## Heap Tracing -Please refer to this doc. +Please refer to this doc. # Installing IDF Eclipse Plugin from Eclipse Market Place @@ -476,7 +476,7 @@ Please follow the steps below to install IDF Eclipse Plugin from the Eclipse Mar 1. Click on `Install` to follow the installation instructions. 1. Restart the Eclipse. -![](docs/images/market_place.png) +![](docs_readme/images/market_place.png) # Installing IDF Eclipse Plugin from Local Archive @@ -489,7 +489,7 @@ Please follow the steps below to install IDF Eclipse Plugin from the Eclipse Mar 1. Select `Espressif IDF` from the list and proceed with the installation. 1. Restart the Eclipse. -![](docs/images/1_idffeature_install.png) +![](docs_readme/images/1_idffeature_install.png) # How do I upgrade my existing IDF Eclipse Plugin? @@ -507,7 +507,7 @@ If you've already installed IDF Eclipse Plugin using `update site URL`, you can 1. If updates are found, select `Espressif IDF Plugins for Eclipse` and deselect all other items. 1. Click `Next` to proceed with the installation. -![](docs/images/Update_plugins.png) +![](docs_readme/images/Update_plugins.png) # Importing an existing IDF Project @@ -521,7 +521,7 @@ If you've already installed IDF Eclipse Plugin using `update site URL`, you can 1. Provide `Project name` if you wish you have a different name. 1. Click `Finish` to import the selected project into Eclipse workspace as a CMake project. -![](docs/images/5_import_project.png) +![](docs_readme/images/5_import_project.png) # Importing an existing Debug launch configuration @@ -545,10 +545,10 @@ You can now use the GDBStub debugging inside our Eclipse plugin to help you diag To enable GDBStub debugging for a project: 1. Launch the `sdkconfig` in project root by double-clicking on it which will open the configuration editor. -![](docs/images/GDBStubDebugging/sdkconfig_editor.png) +![](docs_readme/images/GDBStubDebugging/sdkconfig_editor.png) 1. Expand the `Component Config` section and select `ESP System Settings`. From the settings on the right for `Panic Handler behaviour` select the `GDBStub on Panic option` from the list. -![](docs/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png) +![](docs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png) Now you will be taken to the GDBStub debugger automatically when you connect the serial monitor and there is a panic for this example. @@ -569,13 +569,13 @@ To use the GDBStub debugging for a project: ``` The final file should be something like this: -![](docs/images/GDBStubDebugging/code_example.png) +![](docs_readme/images/GDBStubDebugging/code_example.png) Build and flash the project and launch the serial monitor. On line number 45, we are signaling for a failing assert which will put the chip in panic mode and when that line reaches, you will be prompted to switch the perspective to debug mode and the chip will be halted. Remember that this is a panic mode and you cannot continue the execution from here, you will have to stop and restart the chip through IDF commands or simply restart the serial monitor. -![](docs/images/GDBStubDebugging/debug_panic_mode.png) +![](docs_readme/images/GDBStubDebugging/debug_panic_mode.png) You can view the registers stack trace and even view the value of variables in the stack frame. @@ -592,7 +592,7 @@ To enable core dump debugging for a project: 1. You need to enable it first in `sdkconfig`. Launch the `sdkconfig` in the project root by double-clicking on it which will open the configuration editor 1. Click on the `Core Dump` from the settings on the left and select `Data Destination` as `UART`. -![](docs/images/CoreDumpDebugging/sdkconfig_editor.png) +![](docs_readme/images/CoreDumpDebugging/sdkconfig_editor.png) This will enable the core dump debugging and whenever you connect a serial monitor for that project if any crash occurs it will load the dump and open a debug perspective in Eclipse to let you diagnose the dump where you can view all the information in the core dump. @@ -639,15 +639,15 @@ Additional information, including common errors and known issues, is mentioned i # Application Level Tracing ESP-IDF provides a useful feature for program behavior analysis called [Application Level Tracing](https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/app_trace.html?). IDF-Eclipse plugin has UI, that allows the use of start, and stop tracing commands and process received data. To familiarize yourself with this library, you can use the [app_trace_to_host](https://github.com/espressif/esp-idf/tree/release/v5.0/examples/system/app_trace_to_host) project or the [app_trace_basic](https://github.com/espressif/esp-idf/tree/release/v5.1/examples/system/app_trace_basic) project if you are using esp-idf 5.1 and higher. These projects can be created from the plugin itself: -![](docs/images/AppLvlTracing_1.png) +![](docs_readme/images/AppLvlTracing_1.png) Before you start using application-level tracing, it is important to create a debug configuration for the project where you must select the board you are using in order to successfully start the OpenOCD server. -![](docs/images/AppLvlTracing_3.png) +![](docs_readme/images/AppLvlTracing_3.png) After the debug configuration is created, right-click on the project in the Project Explorer and click on `ESP-IDF` > `Application Level Tracing`: -![](docs/images/AppLvlTracing_2.png) +![](docs_readme/images/AppLvlTracing_2.png) It can take a while to open the application level tracing dialog because the OpenOCD server starts first, so you don't need to start it externally. At the very top of the application-level trace dialog, there are auto-configured fields that you can change for the trace start command. @@ -664,7 +664,7 @@ Start command: Additional information can be found [here](https://docs.espressif.com/projects/esp-idf/en/latest/esp32c3/api-guides/app_trace.html?). -![](docs/images/AppLvlTracing_4.png) +![](docs_readme/images/AppLvlTracing_4.png) The next two fields `Trace Processing Script` and `Start Parsing Command` are used to parse the output file. @@ -675,7 +675,7 @@ Note the `Start parse` button is disabled until a dump file is available. To gen When the output file is generated, you can click on `Start parse` button, and you will see the parsed script output in the Eclipse console: -![](docs/images/AppLvlTracing_5.png) +![](docs_readme/images/AppLvlTracing_5.png) # Partition Table Editor UI for ESP-IDF @@ -789,7 +789,7 @@ IDE allows configuring a custom build directory to the project: Note this configuration changes where all the project build artifacts will be generated. -![](docs/images/custombuilddir.png) +![](docs_readme/images/custombuilddir.png) # Wokwi Simulator diff --git a/README_CN.md b/README_CN.md index 4cbbdec59..ed87d979b 100644 --- a/README_CN.md +++ b/README_CN.md @@ -9,9 +9,9 @@ ESP-IDF Eclipse 插件可便利开发人员在 Eclipse 开发环境中开发基 ESP-IDF Eclipse 插件支持 `macOS`、`Windows` 和 `Linux` 操作系统。 -![](docs/images/macos-logo.png) -![](docs/images/windows-logo.png) -![](docs/images/linux-logo.png) +![](docs_readme/images/macos-logo.png) +![](docs_readme/images/windows-logo.png) +![](docs_readme/images/linux-logo.png) > **Note:** 本插件支持基于 `esp32`、`esp32s2`、`esp32s3` 和 `esp32c3` 开发的 ESP-IDF CMake 项目（4.x 及以上）。 @@ -78,7 +78,7 @@ IDF Eclipse 插件的运行环境要求如下。 此外，我们还为 Windows 用户提供 `Espressif-IDE 离线安装器`，集成了 OpenJDK、Python、CMake、Git、ESP-IDF、Eclipse IDE、IDF Eclipse 插件及相关构建工具，请见 Espressif-IDE 离线安装器 。 -更多有关 Espressif-IDE 的信息，请见 这里。 +更多有关 Espressif-IDE 的信息，请见 这里。 @@ -98,7 +98,7 @@ IDF Eclipse 插件的运行环境要求如下。 > **Note:** 本文档中的所有截图均来自 `macOS` 操作系统，但安装步骤同时适用于 `Windows`、`Linux` 和 `macOS` 操作系统。 -![](docs/images/zh/idf_update_site_install.png) +![](docs_readme/images/zh/idf_update_site_install.png) # 安装 ESP-IDF @@ -118,7 +118,7 @@ IDF Eclipse 插件的运行环境要求如下。 本操作将下载指定的 ESP-IDF 版本，并配置 Eclipse CDT 构建环境变量中的 `IDF_PATH`。 -![](docs/images/zh/espidf_download.png) +![](docs_readme/images/zh/espidf_download.png) # 安装 ESP-IDF 工具集 @@ -134,11 +134,11 @@ ESP-IDF 在构建固件时需要一些工具，包括 Python、Git、交叉编 > **Note:** 本步骤将按照 `idf_tools.py export` 命令，将 `IDF_PATH`、`PATH`、`OPENOCD_SCRIPTS` 和 `IDF_PYTHON_ENV_PATH` 设置为 Eclipse CDT 构建环境。因此，即使您以前已安装过上述工具，也不可跳过该步骤。 -![](docs/images/install_tools.png) +![](docs_readme/images/install_tools.png) ESP-IDF 目录选择对话框： -![](docs/images/zh/esp_idf_dir.png) +![](docs_readme/images/zh/esp_idf_dir.png) # 创建一个新项目 @@ -152,7 +152,7 @@ ESP-IDF 目录选择对话框： > **Note:** 完成以上操作后，您将在编辑器中看到许多未解决的 include 错误。这些错误仅在构建完成后才能解决。 -![](docs/images/zh/3_new_project_default.png) +![](docs_readme/images/zh/3_new_project_default.png) # 配置启动目标 @@ -164,7 +164,7 @@ ESP-IDF 目录选择对话框： 1. 选择 `ESP 目标`。 1. 提供目标属性，即您希望启动应用程序的位置。输入目标`名称`，并选择您连接 ESP 设备的`串口`。 -![](docs/images/zh/8_launch_target.png) +![](docs_readme/images/zh/8_launch_target.png) # 编译项目 @@ -175,7 +175,7 @@ ESP-IDF 目录选择对话框： 1. 点击顶部工具栏中左起第三个下拉窗口`启动目标`，选择您需要启动的目标。 1. 现在，点击顶部工具栏左上角的`构建`按钮。 -![](docs/images/9_cmake_build.png) +![](docs_readme/images/9_cmake_build.png) # 烧录项目 @@ -184,7 +184,7 @@ ESP-IDF 的 `idf.py` 工具可以打包 `make flash` 命令和常用指令。用 如需使用自定义烧录参数，请前往[这里](#customizeLaunchConfig) 获取详细步骤。 -如需通过 JTAG 进行烧录，请见 JTAG 烧录指南。 +如需通过 JTAG 进行烧录，请见 JTAG 烧录指南。 # 查看串口输出 @@ -197,7 +197,7 @@ ESP-IDF 的 `idf.py` 工具可以打包 `make flash` 命令和常用指令。用 1. 配置`串口监视器`过滤器，对串口输出进行过滤。 1. 点击 `OK` 启动终端，开始监听 USB 端口。 -![](docs/images/zh/10_serial_terminal.png) +![](docs_readme/images/zh/10_serial_terminal.png) ### ESP-IDF 串口监视器设置 @@ -216,7 +216,7 @@ ESP-IDF 的 `idf.py` 工具可以打包 `make flash` 命令和常用指令。用 ## GDB OpenOCD 调试 -请见 GDB OpenOCD 调试。 +请见 GDB OpenOCD 调试。 # 其他 IDE 功能 @@ -233,7 +233,7 @@ ESP-IDF 的 `idf.py` 工具可以打包 `make flash` 命令和常用指令。用 > **Note:** 完成以上操作后，您将在编辑器中看到许多未解决的 include 错误。这些错误仅在构建完成后才能解决。 -![](docs/images/4_new_project_templates.png) +![](docs_readme/images/4_new_project_templates.png) # 工具安装助手 @@ -243,16 +243,16 @@ ESP-IDF 的 `idf.py` 工具可以打包 `make flash` 命令和常用指令。用 具体步骤如下： 1. 前往 `乐鑫` > `ESP-IDF 工具管理器` > `工具安装助手（预览版）`。 -![](docs/images/ToolsManager/install_tools_manager.png) +![](docs_readme/images/ToolsManager/install_tools_manager.png) 1. 等待安装助手启动，选择 Git 和 Python 的安装路径（如您已添加系统 PATH，则路径可自动填充）。然后，点击 `下一步`。 -![](docs/images/ToolsManager/git_python_selection.png) +![](docs_readme/images/ToolsManager/git_python_selection.png) 1. 选择本地已安装 ESP-IDF 文件夹，或从下拉菜单中选择不同版本安装 ESP-IDF，比如选择列表中的 master 可以帮您从 GitHub 中克隆 ESP-IDF 的 master 分支。 -![](docs/images/ToolsManager/select_or_download_new_esp_idf.png) +![](docs_readme/images/ToolsManager/select_or_download_new_esp_idf.png) 1. 点击 `下一步` 查看针对您的 ESP-IDF 版本的可用工具。此时，您可以选择安装所有推荐工具，或仅选择您需要的工具（可按照工具名称或目标进行筛选）。接着，安装助手将下载并安装所有所需的工具。安装完成后，您就可以创建项目了。 -![](docs/images/ToolsManager/manage_tools_installation.png) +![](docs_readme/images/ToolsManager/manage_tools_installation.png) # SDK 配置编辑器 @@ -266,18 +266,18 @@ ESP-IDF Eclipse 插件允许用户直接在 Eclipse 环境中配置 `sdkconfig` 1. 完成更改后，可使用 `Ctrl+S` 或 `Command+S` 保存更改。也可以点击 Eclipse 工具栏中的`保存`按钮进行保存。 1. 如需撤回对 sdkconfig 编辑器的更改，用户可选择不保存退出编辑器；也可右键 `sdkconfig` 文件并选择`加载 sdkconfig` 菜单选项，恢复对编辑器的修改。 -![](docs/images/13_sdkconfig_editor.png) +![](docs_readme/images/13_sdkconfig_editor.png) # CMake 编辑器 ESP-IDF Eclipse 插件中还集成了一个 CMake 编辑器，允许用户编辑 CMakeList.txt 等 CMake 文件，支持语法高亮、CMake 命令助手、代码模板等功能。 -![](docs/images/cmake_editor_ca.png) +![](docs_readme/images/cmake_editor_ca.png) 如需配置 CMake 编辑器，请前往 Eclipse 的 `偏好设置` > `CMakeEd`。 -![](docs/images/zh/cmake_editor_preferences.png) +![](docs_readme/images/zh/cmake_editor_preferences.png) # ESP-IDF 应用程序内存分析 @@ -295,11 +295,11 @@ ESP-IDF Eclipse 插件中还集成了一个 CMake 编辑器，允许用户编辑 **应用程序内存分析 - 概述** -![](docs/images/zh/sizeanalysis_overview.png) +![](docs_readme/images/zh/sizeanalysis_overview.png) **应用程序内存分析 - 详情** -![](docs/images/zh/sizeanalysis_details.png) +![](docs_readme/images/zh/sizeanalysis_details.png) # ESP-IDF 终端 @@ -313,7 +313,7 @@ ESP-IDF Eclipse 插件中还集成了一个 CMake 编辑器，允许用户编辑 1. 点击工具栏中的`打开终端`图标。 1. 从终端下拉菜单中选择`ESP-IDF 终端`，并点击`OK`启动终端。 -![](docs/images/zh/idf_terminal.png) +![](docs_readme/images/zh/idf_terminal.png) # 安装 ESP-IDF 组件 @@ -322,12 +322,12 @@ ESP-IDF Eclipse 插件中还集成了一个 CMake 编辑器，允许用户编辑 * 从`项目浏览器`中选择需要安装组件的项目，并选择 `安装 ESP-IDF 组件`。 - ![](docs/images/ESP-IDF_Components/install_components.png) + ![](docs_readme/images/ESP-IDF_Components/install_components.png) 查看所有可安装的组件。 * 选中需要安装的组件，并点击 `安装`。此外，您还可以点击 `更多信息`，查看具体组件的更多信息。 - ![](docs/images/ESP-IDF_Components/components_window.png) + ![](docs_readme/images/ESP-IDF_Components/components_window.png) 注意，已经安装的组件也会出现的列表中，但 `安装` 选项（`已安装`选项旁边）将禁用。 @@ -361,7 +361,7 @@ ESP-IDF Eclipse 插件中还集成了一个 CMake 编辑器，允许用户编辑 ##### PATH ##### `/Users/user-name/.espressif/tools/xtensa-esp32-elf/esp32-2019r1-8.2.0/xtensa-esp32-elf/bin:/Users/user-name/.espressif/tools/esp32ulp-elf/2.28.51.20170517/esp32ulp-elf-binutils/bin:/Users/user-name/.espressif/tools/cmake/3.13.4/CMake.app/Contents/bin:/Users/user-name/.espressif/tools/openocd-esp32/v0.10.0-esp32-20190313/openocd-esp32/bin:/Users/user-name/.espressif/tools/ninja/1.9.0/:/Users/user-name/.espressif/python_env/idf4.0_py3.7_env/bin:/Users/user-name/esp/esp-idf/tools:$PATH` -![](docs/images/zh/2_environment_pref.png) +![](docs_readme/images/zh/2_environment_pref.png) # 配置工具链 @@ -383,7 +383,7 @@ ESP-IDF Eclipse 插件中还集成了一个 CMake 编辑器，允许用户编辑 * **操作系统：** esp32, * **CPU 架构：** xtensa -![](docs/images/6_core_build_toolchains.png) +![](docs_readme/images/6_core_build_toolchains.png) # 配置 CMake 工具链 @@ -397,7 +397,7 @@ ESP-IDF Eclipse 插件中还集成了一个 CMake 编辑器，允许用户编辑 > **Note:** Eclipse CDT 在保存工具链偏好设置时有一个已知 bug。因此，我们建议在进行后续操作前，重新启动 Eclipse。 -![](docs/images/7_cmake_toolchain.png) +![](docs_readme/images/7_cmake_toolchain.png) # 选择 Clang 工具链 @@ -426,9 +426,9 @@ ESP-IDF Eclipse 插件 v2.7.0 及以上版本支持使用 Clang 工具链构建 1. 点击 `OK`，保存设置。 1. 点击`启动`图标，将应用程序烧录到选定的开发板中。 -![](docs/images/zh/11_launch_configuration.png) +![](docs_readme/images/zh/11_launch_configuration.png) -![](docs/images/12_flashing.png) +![](docs_readme/images/12_flashing.png) # 更改语言 @@ -440,7 +440,7 @@ IDF Eclipse 插件可支持不同语言。如需更改，请按照以下步骤 1. 在子下拉菜单中选择所需的语言。 1. 此后，Eclipse 重启后将切换至所选择的语言。 -![](docs/images/change_language.png) +![](docs_readme/images/change_language.png) 注意，上述操作仅提供针对插件界面的汉化。如需全部汉化，则请另外安装 Eclipse 汉化包。 @@ -474,7 +474,7 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 注意，在提交问题时一定要提供错误日志。 -![](docs/images/zh/export_log.png) +![](docs_readme/images/zh/export_log.png) ## 控制台视图日志 @@ -482,7 +482,7 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 打开`控制台`视图，请前往`窗口`>`显示视图`>`控制台`。 -![](docs/images/CDT_Build_Console.png) +![](docs_readme/images/CDT_Build_Console.png) ## CDT 全局构建日志 @@ -496,11 +496,11 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 如本控制台未自动启动，请前往`中控台`视图，点击`显示选中的中控台`按钮。 -![](docs/images/zh/IDF_tools_console.png) +![](docs_readme/images/zh/IDF_tools_console.png) ## 堆栈追踪 -详见这里。 +详见这里。 # 从 Eclipse 市场安装 IDF Eclipse 插件 @@ -512,7 +512,7 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 1. 点击`安装`，并按照提示完成所有安装步骤。 1. 重启 Eclipse。 -![](docs/images/market_place.png) +![](docs_readme/images/market_place.png) # 从本地文件安装 IDF Eclipse 插件 @@ -525,7 +525,7 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 1. 从列表中选择 `Espressif IDF`，并按照提示完成所有安装步骤。 1. 重启 Eclipse。 -![](docs/images/zh/1_idffeature_install.png) +![](docs_readme/images/zh/1_idffeature_install.png) # 如何升级我的 IDF Eclipse 插件？ @@ -543,7 +543,7 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 1. 如有新的更新，请选择`乐鑫 IDF 插件`，并取消勾选所有其他项目。 1. 点击`下一步`，并按照提示完成所有安装步骤。 -![](docs/images/Update_plugins.png) +![](docs_readme/images/Update_plugins.png) # 导入一个现有的 IDF 项目 @@ -557,7 +557,7 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 1. 更改 `项目名称`（否则将使用默认名称）。 1. 点击`完成`，将选定项目作为一个 CMake 项目导入 Eclipse 工作空间。 -![](docs/images/zh/5_import_project.png) +![](docs_readme/images/zh/5_import_project.png) # 导入一个现有的 Debug 启动配置 @@ -581,10 +581,10 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 使能 GDBStub 调试功能： 1. 前往 `sdkconfig` 打开配置编辑器。 -![](docs/images/GDBStubDebugging/sdkconfig_editor.png) +![](docs_readme/images/GDBStubDebugging/sdkconfig_editor.png) 1. 展开 `Component Config` 部分，并选择 `ESP System Settings`；窗口右侧在 `Panic handler behaviour` 中选择 `GDBStub on Panic`。 -![](docs/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png) +![](docs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png) 至此，实例一旦发生 panic，则串口监视器将自动进入 GDBStub 调试页面。 @@ -605,13 +605,13 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ ``` 最终文件实例： -![](docs/images/GDBStubDebugging/code_example.png) +![](docs_readme/images/GDBStubDebugging/code_example.png) 构建烧录项目，并启动串口监视器。我们在第 45 行发送一个失败信号，这会使芯片进入 panic 模式。之后会跳出调试模式界面，此时芯片将停止工作。 注意，芯片进入 panic 模式后无法再从断点继续执行，您必须停止运行并重新启动芯片（使用 idf 命令或重新启动串口监视器）。 -![](docs/images/GDBStubDebugging/debug_panic_mode.png) +![](docs_readme/images/GDBStubDebugging/debug_panic_mode.png) 您可以在此界面查看寄存器堆栈踪迹，甚至堆栈框架中变量的值。 @@ -628,7 +628,7 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ 1. 在项目的根目录中打开 `sdkconfig` 文件。此时，你会看到配置编辑器窗口。 1. 在左侧列表中选择 `Core Dump`，并将 `Data Destination` 配置为 `UART`。 -![](docs/images/CoreDumpDebugging/sdkconfig_editor.png) +![](docs_readme/images/CoreDumpDebugging/sdkconfig_editor.png) 至此，core dump 功能已经打开。此后，一旦项目发生任何崩溃，仅需打开串口监控器即可查看 core dump 信息，还可在 eclipse 中打开调试视图，方便用户的诊断。 @@ -675,15 +675,15 @@ ESP-IDF 项目构建中的大多数常见错误均可从提示数据库 (`tools/ ESP-IDF 的[应用层追踪](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32c3/api-guides/app_trace.html) 功能可用于分析程序行为。ESP-IDF Eclipse 插件也特别提供了用户界面，允许通过命令开始/停止追踪，并进行数据处理。具体参考可见 [app_trace_to_host](https://github.com/espressif/esp-idf/tree/master/examples/system/app_trace_to_host) 项目，创建方式如下： -![](docs/images/AppLvlTracing_1.png) +![](docs_readme/images/AppLvlTracing_1.png) 启动应用层追踪功能之前，请首先完成项目的调试配置，包括指定使用的开发板名称。否则无法正常启动 OpenOCD 服务器。 -![](docs/images/AppLvlTracing_3.png) +![](docs_readme/images/AppLvlTracing_3.png) 配置完成后，从 `项目浏览器` 中选择您的项目，并点击 `ESP-IDF:Application Level Tracing`： -![](docs/images/AppLvlTracing_2.png) +![](docs_readme/images/AppLvlTracing_2.png) 注意，本功能需要调用 OpenOCD 服务器，因此启动需要一定时间，请耐心等待。另外，调用自动完成，无需从外部特别打开 OpenOCD 服务器。应用层追踪启动后会自动填充一些配置，您也可以根据个人需要修改。 @@ -700,7 +700,7 @@ ESP-IDF 的[应用层追踪](https://docs.espressif.com/projects/esp-idf/zh_CN/l 更多信息，请见[这里](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32c3/api-guides/app_trace.html?)。 -![](docs/images/AppLvlTracing_4.png) +![](docs_readme/images/AppLvlTracing_4.png) 另外两个参数 `Trace Processing Script` 和 `Start Parsing Command` 用于解析输出文件。 @@ -711,7 +711,7 @@ ESP-IDF 的[应用层追踪](https://docs.espressif.com/projects/esp-idf/zh_CN/l 此后，点击 `Start parse` 按钮，从 Eclipse 控制台查看解析脚本的输出： -![](docs/images/AppLvlTracing_5.png) +![](docs_readme/images/AppLvlTracing_5.png) # ESP-IDF Master 更新 @@ -825,7 +825,7 @@ IDE 支持配置自定义构架目录： 注意，此配置将改变所有项目构建 artifact 的保存路径。 -![](docs/images/custombuilddir.png) +![](docs_readme/images/custombuilddir.png) # Wokwi 模拟器 diff --git a/docs/Espressif-IDE-Windows-Installer.md b/docs_readme/Espressif-IDE-Windows-Installer.md similarity index 100% rename from docs/Espressif-IDE-Windows-Installer.md rename to docs_readme/Espressif-IDE-Windows-Installer.md diff --git a/docs/Espressif-IDE.md b/docs_readme/Espressif-IDE.md similarity index 97% rename from docs/Espressif-IDE.md rename to docs_readme/Espressif-IDE.md index f7de5d02b..8fc7aebf6 100644 --- a/docs/Espressif-IDE.md +++ b/docs_readme/Espressif-IDE.md @@ -53,6 +53,6 @@ After un-archiving, if the application still complains, check/remove the attribu $ xattr -dr com.apple.quarantine ~/Downloads/Espressif-IDE.app ``` ### Other Topics -- [Installing Espressif-IDE by Windows Offline Installer](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/Espressif-IDE-Windows-Installer.md) +- [Installing Espressif-IDE by Windows Offline Installer](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE-Windows-Installer.md) - [Updating Espressif-IDE with the Latest Version](https://github.com/espressif/idf-eclipse-plugin#installing-idf-plugin-using-update-site-url) diff --git a/docs/HeapTracing.md b/docs_readme/HeapTracing.md similarity index 100% rename from docs/HeapTracing.md rename to docs_readme/HeapTracing.md diff --git a/docs/JTAG Flashing.md b/docs_readme/JTAG Flashing.md similarity index 100% rename from docs/JTAG Flashing.md rename to docs_readme/JTAG Flashing.md diff --git a/docs/MissingToolsManualPathUpdateGuide.md b/docs_readme/MissingToolsManualPathUpdateGuide.md similarity index 100% rename from docs/MissingToolsManualPathUpdateGuide.md rename to docs_readme/MissingToolsManualPathUpdateGuide.md diff --git a/docs/OpenOCD Debugging.md b/docs_readme/OpenOCD Debugging.md similarity index 98% rename from docs/OpenOCD Debugging.md rename to docs_readme/OpenOCD Debugging.md index 018fd10a2..1eb6496fd 100644 --- a/docs/OpenOCD Debugging.md +++ b/docs_readme/OpenOCD Debugging.md @@ -100,5 +100,5 @@ You can customize the `Debug perspective` in your own way, for example, move som * Please [check](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html#selecting-jtag-adapter) if the board is having JTAG enabled. * If there is any OpenOCD timeout issue, please [increase the GDB server timeout value](https://www.esp32.com/viewtopic.php?f=40&t=36164#p122701) from the preferences. Usually this happens while working with big size applications. * If you see any error while debugging, please check this [OpenOCD troubleshooting FAQ guide](https://github.com/espressif/openocd-esp32/wiki/Troubleshooting-FAQ) and see if that helps to resolve the issue. -* If you have any issue and want to enable OpenOCD debugging verbose, please check [Enable verbose output](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/OpenOCD%20Debugging.md#startup-tab) option from the startup tab. +* If you have any issue and want to enable OpenOCD debugging verbose, please check [Enable verbose output](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/OpenOCD%20Debugging.md#startup-tab) option from the startup tab. diff --git a/docs/clangd_cdt_support.md b/docs_readme/clangd_cdt_support.md similarity index 100% rename from docs/clangd_cdt_support.md rename to docs_readme/clangd_cdt_support.md diff --git a/docs/images/10_serial_terminal.png b/docs_readme/images/10_serial_terminal.png similarity index 100% rename from docs/images/10_serial_terminal.png rename to docs_readme/images/10_serial_terminal.png diff --git a/docs/images/11_launch_configuration.png b/docs_readme/images/11_launch_configuration.png similarity index 100% rename from docs/images/11_launch_configuration.png rename to docs_readme/images/11_launch_configuration.png diff --git a/docs/images/12_flashing.png b/docs_readme/images/12_flashing.png similarity index 100% rename from docs/images/12_flashing.png rename to docs_readme/images/12_flashing.png diff --git a/docs/images/13_sdkconfig_editor.png b/docs_readme/images/13_sdkconfig_editor.png similarity index 100% rename from docs/images/13_sdkconfig_editor.png rename to docs_readme/images/13_sdkconfig_editor.png diff --git a/docs/images/1_idffeature_install.png b/docs_readme/images/1_idffeature_install.png similarity index 100% rename from docs/images/1_idffeature_install.png rename to docs_readme/images/1_idffeature_install.png diff --git a/docs/images/2_environment_pref.png b/docs_readme/images/2_environment_pref.png similarity index 100% rename from docs/images/2_environment_pref.png rename to docs_readme/images/2_environment_pref.png diff --git a/docs/images/3_new_project_default.png b/docs_readme/images/3_new_project_default.png similarity index 100% rename from docs/images/3_new_project_default.png rename to docs_readme/images/3_new_project_default.png diff --git a/docs/images/4_new_project_templates.png b/docs_readme/images/4_new_project_templates.png similarity index 100% rename from docs/images/4_new_project_templates.png rename to docs_readme/images/4_new_project_templates.png diff --git a/docs/images/5_import_project.png b/docs_readme/images/5_import_project.png similarity index 100% rename from docs/images/5_import_project.png rename to docs_readme/images/5_import_project.png diff --git a/docs/images/6_core_build_toolchains.png b/docs_readme/images/6_core_build_toolchains.png similarity index 100% rename from docs/images/6_core_build_toolchains.png rename to docs_readme/images/6_core_build_toolchains.png diff --git a/docs/images/7_cmake_toolchain.png b/docs_readme/images/7_cmake_toolchain.png similarity index 100% rename from docs/images/7_cmake_toolchain.png rename to docs_readme/images/7_cmake_toolchain.png diff --git a/docs/images/8_launch_target.png b/docs_readme/images/8_launch_target.png similarity index 100% rename from docs/images/8_launch_target.png rename to docs_readme/images/8_launch_target.png diff --git a/docs/images/9_cmake_build.png b/docs_readme/images/9_cmake_build.png similarity index 100% rename from docs/images/9_cmake_build.png rename to docs_readme/images/9_cmake_build.png diff --git a/docs/images/AppLvlTracing_1.png b/docs_readme/images/AppLvlTracing_1.png similarity index 100% rename from docs/images/AppLvlTracing_1.png rename to docs_readme/images/AppLvlTracing_1.png diff --git a/docs/images/AppLvlTracing_2.png b/docs_readme/images/AppLvlTracing_2.png similarity index 100% rename from docs/images/AppLvlTracing_2.png rename to docs_readme/images/AppLvlTracing_2.png diff --git a/docs/images/AppLvlTracing_3.png b/docs_readme/images/AppLvlTracing_3.png similarity index 100% rename from docs/images/AppLvlTracing_3.png rename to docs_readme/images/AppLvlTracing_3.png diff --git a/docs/images/AppLvlTracing_4.png b/docs_readme/images/AppLvlTracing_4.png similarity index 100% rename from docs/images/AppLvlTracing_4.png rename to docs_readme/images/AppLvlTracing_4.png diff --git a/docs/images/AppLvlTracing_5.png b/docs_readme/images/AppLvlTracing_5.png similarity index 100% rename from docs/images/AppLvlTracing_5.png rename to docs_readme/images/AppLvlTracing_5.png diff --git a/docs/images/CDT_Build_Console.png b/docs_readme/images/CDT_Build_Console.png similarity index 100% rename from docs/images/CDT_Build_Console.png rename to docs_readme/images/CDT_Build_Console.png diff --git a/docs/images/CoreDumpDebugging/sdkconfig_editor.png b/docs_readme/images/CoreDumpDebugging/sdkconfig_editor.png similarity index 100% rename from docs/images/CoreDumpDebugging/sdkconfig_editor.png rename to docs_readme/images/CoreDumpDebugging/sdkconfig_editor.png diff --git a/docs/images/ESP-IDF_Components/components_window.png b/docs_readme/images/ESP-IDF_Components/components_window.png similarity index 100% rename from docs/images/ESP-IDF_Components/components_window.png rename to docs_readme/images/ESP-IDF_Components/components_window.png diff --git a/docs/images/ESP-IDF_Components/install_components.png b/docs_readme/images/ESP-IDF_Components/install_components.png similarity index 100% rename from docs/images/ESP-IDF_Components/install_components.png rename to docs_readme/images/ESP-IDF_Components/install_components.png diff --git a/docs/images/GDBStubDebugging/code_example.png b/docs_readme/images/GDBStubDebugging/code_example.png similarity index 100% rename from docs/images/GDBStubDebugging/code_example.png rename to docs_readme/images/GDBStubDebugging/code_example.png diff --git a/docs/images/GDBStubDebugging/debug_panic_mode.png b/docs_readme/images/GDBStubDebugging/debug_panic_mode.png similarity index 100% rename from docs/images/GDBStubDebugging/debug_panic_mode.png rename to docs_readme/images/GDBStubDebugging/debug_panic_mode.png diff --git a/docs/images/GDBStubDebugging/sdkconfig_editor.png b/docs_readme/images/GDBStubDebugging/sdkconfig_editor.png similarity index 100% rename from docs/images/GDBStubDebugging/sdkconfig_editor.png rename to docs_readme/images/GDBStubDebugging/sdkconfig_editor.png diff --git a/docs/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png b/docs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png similarity index 100% rename from docs/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png rename to docs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.png diff --git a/docs/images/HeapTracing/analysis_context_menu.png b/docs_readme/images/HeapTracing/analysis_context_menu.png similarity index 100% rename from docs/images/HeapTracing/analysis_context_menu.png rename to docs_readme/images/HeapTracing/analysis_context_menu.png diff --git a/docs/images/HeapTracing/breakpoint_properties_actions.png b/docs_readme/images/HeapTracing/breakpoint_properties_actions.png similarity index 100% rename from docs/images/HeapTracing/breakpoint_properties_actions.png rename to docs_readme/images/HeapTracing/breakpoint_properties_actions.png diff --git a/docs/images/HeapTracing/breakpoint_properties_actions_start_attached.png b/docs_readme/images/HeapTracing/breakpoint_properties_actions_start_attached.png similarity index 100% rename from docs/images/HeapTracing/breakpoint_properties_actions_start_attached.png rename to docs_readme/images/HeapTracing/breakpoint_properties_actions_start_attached.png diff --git a/docs/images/HeapTracing/breakpoint_properties_actions_stop_attached.png b/docs_readme/images/HeapTracing/breakpoint_properties_actions_stop_attached.png similarity index 100% rename from docs/images/HeapTracing/breakpoint_properties_actions_stop_attached.png rename to docs_readme/images/HeapTracing/breakpoint_properties_actions_stop_attached.png diff --git a/docs/images/HeapTracing/breakpoint_properties_popup.png b/docs_readme/images/HeapTracing/breakpoint_properties_popup.png similarity index 100% rename from docs/images/HeapTracing/breakpoint_properties_popup.png rename to docs_readme/images/HeapTracing/breakpoint_properties_popup.png diff --git a/docs/images/HeapTracing/callers_view.png b/docs_readme/images/HeapTracing/callers_view.png similarity index 100% rename from docs/images/HeapTracing/callers_view.png rename to docs_readme/images/HeapTracing/callers_view.png diff --git a/docs/images/HeapTracing/details_tab_tracing.png b/docs_readme/images/HeapTracing/details_tab_tracing.png similarity index 100% rename from docs/images/HeapTracing/details_tab_tracing.png rename to docs_readme/images/HeapTracing/details_tab_tracing.png diff --git a/docs/images/HeapTracing/heap_tracing_action.png b/docs_readme/images/HeapTracing/heap_tracing_action.png similarity index 100% rename from docs/images/HeapTracing/heap_tracing_action.png rename to docs_readme/images/HeapTracing/heap_tracing_action.png diff --git a/docs/images/HeapTracing/overview_tab_tracing.png b/docs_readme/images/HeapTracing/overview_tab_tracing.png similarity index 100% rename from docs/images/HeapTracing/overview_tab_tracing.png rename to docs_readme/images/HeapTracing/overview_tab_tracing.png diff --git a/docs/images/HeapTracing/overview_tab_tracing_contexts.png b/docs_readme/images/HeapTracing/overview_tab_tracing_contexts.png similarity index 100% rename from docs/images/HeapTracing/overview_tab_tracing_contexts.png rename to docs_readme/images/HeapTracing/overview_tab_tracing_contexts.png diff --git a/docs/images/HeapTracing/show_callers_context_menu.png b/docs_readme/images/HeapTracing/show_callers_context_menu.png similarity index 100% rename from docs/images/HeapTracing/show_callers_context_menu.png rename to docs_readme/images/HeapTracing/show_callers_context_menu.png diff --git a/docs/images/HeapTracing/sysview_heap_log_file.PNG b/docs_readme/images/HeapTracing/sysview_heap_log_file.PNG similarity index 100% rename from docs/images/HeapTracing/sysview_heap_log_file.PNG rename to docs_readme/images/HeapTracing/sysview_heap_log_file.PNG diff --git a/docs/images/IDF_tools_console.png b/docs_readme/images/IDF_tools_console.png similarity index 100% rename from docs/images/IDF_tools_console.png rename to docs_readme/images/IDF_tools_console.png diff --git a/docs/images/JtagFlash_1.png b/docs_readme/images/JtagFlash_1.png similarity index 100% rename from docs/images/JtagFlash_1.png rename to docs_readme/images/JtagFlash_1.png diff --git a/docs/images/JtagFlash_2.png b/docs_readme/images/JtagFlash_2.png similarity index 100% rename from docs/images/JtagFlash_2.png rename to docs_readme/images/JtagFlash_2.png diff --git a/docs/images/JtagFlash_3.png b/docs_readme/images/JtagFlash_3.png similarity index 100% rename from docs/images/JtagFlash_3.png rename to docs_readme/images/JtagFlash_3.png diff --git a/docs/images/OpenOCDDebug_1.png b/docs_readme/images/OpenOCDDebug_1.png similarity index 100% rename from docs/images/OpenOCDDebug_1.png rename to docs_readme/images/OpenOCDDebug_1.png diff --git a/docs/images/OpenOCDDebug_10.png b/docs_readme/images/OpenOCDDebug_10.png similarity index 100% rename from docs/images/OpenOCDDebug_10.png rename to docs_readme/images/OpenOCDDebug_10.png diff --git a/docs/images/OpenOCDDebug_11.png b/docs_readme/images/OpenOCDDebug_11.png similarity index 100% rename from docs/images/OpenOCDDebug_11.png rename to docs_readme/images/OpenOCDDebug_11.png diff --git a/docs/images/OpenOCDDebug_12.png b/docs_readme/images/OpenOCDDebug_12.png similarity index 100% rename from docs/images/OpenOCDDebug_12.png rename to docs_readme/images/OpenOCDDebug_12.png diff --git a/docs/images/OpenOCDDebug_13.png b/docs_readme/images/OpenOCDDebug_13.png similarity index 100% rename from docs/images/OpenOCDDebug_13.png rename to docs_readme/images/OpenOCDDebug_13.png diff --git a/docs/images/OpenOCDDebug_2.png b/docs_readme/images/OpenOCDDebug_2.png similarity index 100% rename from docs/images/OpenOCDDebug_2.png rename to docs_readme/images/OpenOCDDebug_2.png diff --git a/docs/images/OpenOCDDebug_3.png b/docs_readme/images/OpenOCDDebug_3.png similarity index 100% rename from docs/images/OpenOCDDebug_3.png rename to docs_readme/images/OpenOCDDebug_3.png diff --git a/docs/images/OpenOCDDebug_4.png b/docs_readme/images/OpenOCDDebug_4.png similarity index 100% rename from docs/images/OpenOCDDebug_4.png rename to docs_readme/images/OpenOCDDebug_4.png diff --git a/docs/images/OpenOCDDebug_5.png b/docs_readme/images/OpenOCDDebug_5.png similarity index 100% rename from docs/images/OpenOCDDebug_5.png rename to docs_readme/images/OpenOCDDebug_5.png diff --git a/docs/images/OpenOCDDebug_6.png b/docs_readme/images/OpenOCDDebug_6.png similarity index 100% rename from docs/images/OpenOCDDebug_6.png rename to docs_readme/images/OpenOCDDebug_6.png diff --git a/docs/images/OpenOCDDebug_7.png b/docs_readme/images/OpenOCDDebug_7.png similarity index 100% rename from docs/images/OpenOCDDebug_7.png rename to docs_readme/images/OpenOCDDebug_7.png diff --git a/docs/images/OpenOCDDebug_8.png b/docs_readme/images/OpenOCDDebug_8.png similarity index 100% rename from docs/images/OpenOCDDebug_8.png rename to docs_readme/images/OpenOCDDebug_8.png diff --git a/docs/images/OpenOCDDebug_9.png b/docs_readme/images/OpenOCDDebug_9.png similarity index 100% rename from docs/images/OpenOCDDebug_9.png rename to docs_readme/images/OpenOCDDebug_9.png diff --git a/docs/images/Preference_recorder.png b/docs_readme/images/Preference_recorder.png similarity index 100% rename from docs/images/Preference_recorder.png rename to docs_readme/images/Preference_recorder.png diff --git a/docs/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png b/docs_readme/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png similarity index 100% rename from docs/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png rename to docs_readme/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png diff --git a/docs/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png b/docs_readme/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png similarity index 100% rename from docs/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png rename to docs_readme/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png diff --git a/docs/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png b/docs_readme/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png similarity index 100% rename from docs/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png rename to docs_readme/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png diff --git a/docs/images/ToolsManager/Tool_installed_and_activated.png b/docs_readme/images/ToolsManager/Tool_installed_and_activated.png similarity index 100% rename from docs/images/ToolsManager/Tool_installed_and_activated.png rename to docs_readme/images/ToolsManager/Tool_installed_and_activated.png diff --git a/docs/images/ToolsValidation/EnvSettings.png b/docs_readme/images/ToolsValidation/EnvSettings.png similarity index 100% rename from docs/images/ToolsValidation/EnvSettings.png rename to docs_readme/images/ToolsValidation/EnvSettings.png diff --git a/docs/images/ToolsValidation/PathVarEdit.png b/docs_readme/images/ToolsValidation/PathVarEdit.png similarity index 100% rename from docs/images/ToolsValidation/PathVarEdit.png rename to docs_readme/images/ToolsValidation/PathVarEdit.png diff --git a/docs/images/ToolsValidation/PathVarEdited.png b/docs_readme/images/ToolsValidation/PathVarEdited.png similarity index 100% rename from docs/images/ToolsValidation/PathVarEdited.png rename to docs_readme/images/ToolsValidation/PathVarEdited.png diff --git a/docs/images/Update_plugins.png b/docs_readme/images/Update_plugins.png similarity index 100% rename from docs/images/Update_plugins.png rename to docs_readme/images/Update_plugins.png diff --git a/docs/images/buildconfiguration_clang.png b/docs_readme/images/buildconfiguration_clang.png similarity index 100% rename from docs/images/buildconfiguration_clang.png rename to docs_readme/images/buildconfiguration_clang.png diff --git a/docs/images/change_language.png b/docs_readme/images/change_language.png similarity index 100% rename from docs/images/change_language.png rename to docs_readme/images/change_language.png diff --git a/docs/images/cland_starting.png b/docs_readme/images/cland_starting.png similarity index 100% rename from docs/images/cland_starting.png rename to docs_readme/images/cland_starting.png diff --git a/docs/images/clangd/build_settings_clang.png b/docs_readme/images/clangd/build_settings_clang.png similarity index 100% rename from docs/images/clangd/build_settings_clang.png rename to docs_readme/images/clangd/build_settings_clang.png diff --git a/docs/images/clangd/cdt_indexer_disable.png b/docs_readme/images/clangd/cdt_indexer_disable.png similarity index 100% rename from docs/images/clangd/cdt_indexer_disable.png rename to docs_readme/images/clangd/cdt_indexer_disable.png diff --git a/docs/images/clangd/cdtlsp_updatesite.png b/docs_readme/images/clangd/cdtlsp_updatesite.png similarity index 100% rename from docs/images/clangd/cdtlsp_updatesite.png rename to docs_readme/images/clangd/cdtlsp_updatesite.png diff --git a/docs/images/clangd/clang_compiler_config.png b/docs_readme/images/clangd/clang_compiler_config.png similarity index 100% rename from docs/images/clangd/clang_compiler_config.png rename to docs_readme/images/clangd/clang_compiler_config.png diff --git a/docs/images/clangd/clangd_config.png b/docs_readme/images/clangd/clangd_config.png similarity index 100% rename from docs/images/clangd/clangd_config.png rename to docs_readme/images/clangd/clangd_config.png diff --git a/docs/images/clangd/clangd_context_help.png b/docs_readme/images/clangd/clangd_context_help.png similarity index 100% rename from docs/images/clangd/clangd_context_help.png rename to docs_readme/images/clangd/clangd_context_help.png diff --git a/docs/images/clangd/clangd_editor.png b/docs_readme/images/clangd/clangd_editor.png similarity index 100% rename from docs/images/clangd/clangd_editor.png rename to docs_readme/images/clangd/clangd_editor.png diff --git a/docs/images/clangd/new_cmake_clang_toolchain_config.png b/docs_readme/images/clangd/new_cmake_clang_toolchain_config.png similarity index 100% rename from docs/images/clangd/new_cmake_clang_toolchain_config.png rename to docs_readme/images/clangd/new_cmake_clang_toolchain_config.png diff --git a/docs/images/clangd_consolelog_config.png b/docs_readme/images/clangd_consolelog_config.png similarity index 100% rename from docs/images/clangd_consolelog_config.png rename to docs_readme/images/clangd_consolelog_config.png diff --git a/docs/images/clangd_generic_editor.png b/docs_readme/images/clangd_generic_editor.png similarity index 100% rename from docs/images/clangd_generic_editor.png rename to docs_readme/images/clangd_generic_editor.png diff --git a/docs/images/clangd_preference.png b/docs_readme/images/clangd_preference.png similarity index 100% rename from docs/images/clangd_preference.png rename to docs_readme/images/clangd_preference.png diff --git a/docs/images/clangd_proposals.png b/docs_readme/images/clangd_proposals.png similarity index 100% rename from docs/images/clangd_proposals.png rename to docs_readme/images/clangd_proposals.png diff --git a/docs/images/clangd_updatesite.png b/docs_readme/images/clangd_updatesite.png similarity index 100% rename from docs/images/clangd_updatesite.png rename to docs_readme/images/clangd_updatesite.png diff --git a/docs/images/cmake_editor_ca.png b/docs_readme/images/cmake_editor_ca.png similarity index 100% rename from docs/images/cmake_editor_ca.png rename to docs_readme/images/cmake_editor_ca.png diff --git a/docs/images/cmake_editor_preferences.png b/docs_readme/images/cmake_editor_preferences.png similarity index 100% rename from docs/images/cmake_editor_preferences.png rename to docs_readme/images/cmake_editor_preferences.png diff --git a/docs/images/code_analysis_disable_symbols.png b/docs_readme/images/code_analysis_disable_symbols.png similarity index 100% rename from docs/images/code_analysis_disable_symbols.png rename to docs_readme/images/code_analysis_disable_symbols.png diff --git a/docs/images/custombuilddir.png b/docs_readme/images/custombuilddir.png similarity index 100% rename from docs/images/custombuilddir.png rename to docs_readme/images/custombuilddir.png diff --git a/docs/images/espressifide_splash.bmp b/docs_readme/images/espressifide_splash.bmp similarity index 100% rename from docs/images/espressifide_splash.bmp rename to docs_readme/images/espressifide_splash.bmp diff --git a/docs/images/export_log.png b/docs_readme/images/export_log.png similarity index 100% rename from docs/images/export_log.png rename to docs_readme/images/export_log.png diff --git a/docs/images/icons/build.png b/docs_readme/images/icons/build.png similarity index 100% rename from docs/images/icons/build.png rename to docs_readme/images/icons/build.png diff --git a/docs/images/icons/debug.png b/docs_readme/images/icons/debug.png similarity index 100% rename from docs/images/icons/debug.png rename to docs_readme/images/icons/debug.png diff --git a/docs/images/icons/delete.png b/docs_readme/images/icons/delete.png similarity index 100% rename from docs/images/icons/delete.png rename to docs_readme/images/icons/delete.png diff --git a/docs/images/icons/run.png b/docs_readme/images/icons/run.png similarity index 100% rename from docs/images/icons/run.png rename to docs_readme/images/icons/run.png diff --git a/docs/images/icons/terminate.png b/docs_readme/images/icons/terminate.png similarity index 100% rename from docs/images/icons/terminate.png rename to docs_readme/images/icons/terminate.png diff --git a/docs/images/idf_terminal.png b/docs_readme/images/idf_terminal.png similarity index 100% rename from docs/images/idf_terminal.png rename to docs_readme/images/idf_terminal.png diff --git a/docs/images/idf_update_site_install.png b/docs_readme/images/idf_update_site_install.png similarity index 100% rename from docs/images/idf_update_site_install.png rename to docs_readme/images/idf_update_site_install.png diff --git a/docs/images/linux-logo.png b/docs_readme/images/linux-logo.png similarity index 100% rename from docs/images/linux-logo.png rename to docs_readme/images/linux-logo.png diff --git a/docs/images/macos-logo.png b/docs_readme/images/macos-logo.png similarity index 100% rename from docs/images/macos-logo.png rename to docs_readme/images/macos-logo.png diff --git a/docs/images/market_place.png b/docs_readme/images/market_place.png similarity index 100% rename from docs/images/market_place.png rename to docs_readme/images/market_place.png diff --git a/docs/images/sizeanalysis_details.png b/docs_readme/images/sizeanalysis_details.png similarity index 100% rename from docs/images/sizeanalysis_details.png rename to docs_readme/images/sizeanalysis_details.png diff --git a/docs/images/sizeanalysis_overview.png b/docs_readme/images/sizeanalysis_overview.png similarity index 100% rename from docs/images/sizeanalysis_overview.png rename to docs_readme/images/sizeanalysis_overview.png diff --git a/docs/images/windows-installation/ide_windows_installer_0.png b/docs_readme/images/windows-installation/ide_windows_installer_0.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_0.png rename to docs_readme/images/windows-installation/ide_windows_installer_0.png diff --git a/docs/images/windows-installation/ide_windows_installer_1.png b/docs_readme/images/windows-installation/ide_windows_installer_1.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_1.png rename to docs_readme/images/windows-installation/ide_windows_installer_1.png diff --git a/docs/images/windows-installation/ide_windows_installer_10.png b/docs_readme/images/windows-installation/ide_windows_installer_10.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_10.png rename to docs_readme/images/windows-installation/ide_windows_installer_10.png diff --git a/docs/images/windows-installation/ide_windows_installer_11.png b/docs_readme/images/windows-installation/ide_windows_installer_11.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_11.png rename to docs_readme/images/windows-installation/ide_windows_installer_11.png diff --git a/docs/images/windows-installation/ide_windows_installer_12.png b/docs_readme/images/windows-installation/ide_windows_installer_12.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_12.png rename to docs_readme/images/windows-installation/ide_windows_installer_12.png diff --git a/docs/images/windows-installation/ide_windows_installer_13.png b/docs_readme/images/windows-installation/ide_windows_installer_13.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_13.png rename to docs_readme/images/windows-installation/ide_windows_installer_13.png diff --git a/docs/images/windows-installation/ide_windows_installer_14.png b/docs_readme/images/windows-installation/ide_windows_installer_14.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_14.png rename to docs_readme/images/windows-installation/ide_windows_installer_14.png diff --git a/docs/images/windows-installation/ide_windows_installer_2.png b/docs_readme/images/windows-installation/ide_windows_installer_2.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_2.png rename to docs_readme/images/windows-installation/ide_windows_installer_2.png diff --git a/docs/images/windows-installation/ide_windows_installer_3.png b/docs_readme/images/windows-installation/ide_windows_installer_3.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_3.png rename to docs_readme/images/windows-installation/ide_windows_installer_3.png diff --git a/docs/images/windows-installation/ide_windows_installer_4.png b/docs_readme/images/windows-installation/ide_windows_installer_4.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_4.png rename to docs_readme/images/windows-installation/ide_windows_installer_4.png diff --git a/docs/images/windows-installation/ide_windows_installer_5.png b/docs_readme/images/windows-installation/ide_windows_installer_5.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_5.png rename to docs_readme/images/windows-installation/ide_windows_installer_5.png diff --git a/docs/images/windows-installation/ide_windows_installer_6.png b/docs_readme/images/windows-installation/ide_windows_installer_6.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_6.png rename to docs_readme/images/windows-installation/ide_windows_installer_6.png diff --git a/docs/images/windows-installation/ide_windows_installer_7.png b/docs_readme/images/windows-installation/ide_windows_installer_7.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_7.png rename to docs_readme/images/windows-installation/ide_windows_installer_7.png diff --git a/docs/images/windows-installation/ide_windows_installer_8.png b/docs_readme/images/windows-installation/ide_windows_installer_8.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_8.png rename to docs_readme/images/windows-installation/ide_windows_installer_8.png diff --git a/docs/images/windows-installation/ide_windows_installer_9.png b/docs_readme/images/windows-installation/ide_windows_installer_9.png similarity index 100% rename from docs/images/windows-installation/ide_windows_installer_9.png rename to docs_readme/images/windows-installation/ide_windows_installer_9.png diff --git a/docs/images/windows-logo.png b/docs_readme/images/windows-logo.png similarity index 100% rename from docs/images/windows-logo.png rename to docs_readme/images/windows-logo.png diff --git a/docs/images/zh/10_serial_terminal.png b/docs_readme/images/zh/10_serial_terminal.png similarity index 100% rename from docs/images/zh/10_serial_terminal.png rename to docs_readme/images/zh/10_serial_terminal.png diff --git a/docs/images/zh/11_launch_configuration.png b/docs_readme/images/zh/11_launch_configuration.png similarity index 100% rename from docs/images/zh/11_launch_configuration.png rename to docs_readme/images/zh/11_launch_configuration.png diff --git a/docs/images/zh/1_idffeature_install.png b/docs_readme/images/zh/1_idffeature_install.png similarity index 100% rename from docs/images/zh/1_idffeature_install.png rename to docs_readme/images/zh/1_idffeature_install.png diff --git a/docs/images/zh/2_environment_pref.png b/docs_readme/images/zh/2_environment_pref.png similarity index 100% rename from docs/images/zh/2_environment_pref.png rename to docs_readme/images/zh/2_environment_pref.png diff --git a/docs/images/zh/3_new_project_default.png b/docs_readme/images/zh/3_new_project_default.png similarity index 100% rename from docs/images/zh/3_new_project_default.png rename to docs_readme/images/zh/3_new_project_default.png diff --git a/docs/images/zh/4_new_project_templates.png b/docs_readme/images/zh/4_new_project_templates.png similarity index 100% rename from docs/images/zh/4_new_project_templates.png rename to docs_readme/images/zh/4_new_project_templates.png diff --git a/docs/images/zh/5_import_project.png b/docs_readme/images/zh/5_import_project.png similarity index 100% rename from docs/images/zh/5_import_project.png rename to docs_readme/images/zh/5_import_project.png diff --git a/docs/images/zh/8_launch_target.png b/docs_readme/images/zh/8_launch_target.png similarity index 100% rename from docs/images/zh/8_launch_target.png rename to docs_readme/images/zh/8_launch_target.png diff --git a/docs/images/zh/ESP-IDF_Components/components_window.png b/docs_readme/images/zh/ESP-IDF_Components/components_window.png similarity index 100% rename from docs/images/zh/ESP-IDF_Components/components_window.png rename to docs_readme/images/zh/ESP-IDF_Components/components_window.png diff --git a/docs/images/zh/ESP-IDF_Components/install_components.png b/docs_readme/images/zh/ESP-IDF_Components/install_components.png similarity index 100% rename from docs/images/zh/ESP-IDF_Components/install_components.png rename to docs_readme/images/zh/ESP-IDF_Components/install_components.png diff --git a/docs/images/zh/GDBStubDebugging/code_example.png b/docs_readme/images/zh/GDBStubDebugging/code_example.png similarity index 100% rename from docs/images/zh/GDBStubDebugging/code_example.png rename to docs_readme/images/zh/GDBStubDebugging/code_example.png diff --git a/docs/images/zh/GDBStubDebugging/debug_panic_mode.png b/docs_readme/images/zh/GDBStubDebugging/debug_panic_mode.png similarity index 100% rename from docs/images/zh/GDBStubDebugging/debug_panic_mode.png rename to docs_readme/images/zh/GDBStubDebugging/debug_panic_mode.png diff --git a/docs/images/zh/GDBStubDebugging/sdkconfig_editor.png b/docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor.png similarity index 100% rename from docs/images/zh/GDBStubDebugging/sdkconfig_editor.png rename to docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor.png diff --git a/docs/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.png b/docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.png similarity index 100% rename from docs/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.png rename to docs_readme/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.png diff --git a/docs/images/zh/HeapTracing/analysis_context_menu.png b/docs_readme/images/zh/HeapTracing/analysis_context_menu.png similarity index 100% rename from docs/images/zh/HeapTracing/analysis_context_menu.png rename to docs_readme/images/zh/HeapTracing/analysis_context_menu.png diff --git a/docs/images/zh/HeapTracing/breakpoint_properties_actions.png b/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions.png similarity index 100% rename from docs/images/zh/HeapTracing/breakpoint_properties_actions.png rename to docs_readme/images/zh/HeapTracing/breakpoint_properties_actions.png diff --git a/docs/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.png b/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.png similarity index 100% rename from docs/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.png rename to docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.png diff --git a/docs/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.png b/docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.png similarity index 100% rename from docs/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.png rename to docs_readme/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.png diff --git a/docs/images/zh/HeapTracing/breakpoint_properties_popup.png b/docs_readme/images/zh/HeapTracing/breakpoint_properties_popup.png similarity index 100% rename from docs/images/zh/HeapTracing/breakpoint_properties_popup.png rename to docs_readme/images/zh/HeapTracing/breakpoint_properties_popup.png diff --git a/docs/images/zh/HeapTracing/callers_view.png b/docs_readme/images/zh/HeapTracing/callers_view.png similarity index 100% rename from docs/images/zh/HeapTracing/callers_view.png rename to docs_readme/images/zh/HeapTracing/callers_view.png diff --git a/docs/images/zh/HeapTracing/details_tab_tracing.png b/docs_readme/images/zh/HeapTracing/details_tab_tracing.png similarity index 100% rename from docs/images/zh/HeapTracing/details_tab_tracing.png rename to docs_readme/images/zh/HeapTracing/details_tab_tracing.png diff --git a/docs/images/zh/HeapTracing/heap_tracing_action.png b/docs_readme/images/zh/HeapTracing/heap_tracing_action.png similarity index 100% rename from docs/images/zh/HeapTracing/heap_tracing_action.png rename to docs_readme/images/zh/HeapTracing/heap_tracing_action.png diff --git a/docs/images/zh/HeapTracing/overview_tab_tracing.png b/docs_readme/images/zh/HeapTracing/overview_tab_tracing.png similarity index 100% rename from docs/images/zh/HeapTracing/overview_tab_tracing.png rename to docs_readme/images/zh/HeapTracing/overview_tab_tracing.png diff --git a/docs/images/zh/HeapTracing/overview_tab_tracing_contexts.png b/docs_readme/images/zh/HeapTracing/overview_tab_tracing_contexts.png similarity index 100% rename from docs/images/zh/HeapTracing/overview_tab_tracing_contexts.png rename to docs_readme/images/zh/HeapTracing/overview_tab_tracing_contexts.png diff --git a/docs/images/zh/HeapTracing/show_callers_context_menu.png b/docs_readme/images/zh/HeapTracing/show_callers_context_menu.png similarity index 100% rename from docs/images/zh/HeapTracing/show_callers_context_menu.png rename to docs_readme/images/zh/HeapTracing/show_callers_context_menu.png diff --git a/docs/images/zh/HeapTracing/sysview_heap_log_file.PNG b/docs_readme/images/zh/HeapTracing/sysview_heap_log_file.PNG similarity index 100% rename from docs/images/zh/HeapTracing/sysview_heap_log_file.PNG rename to docs_readme/images/zh/HeapTracing/sysview_heap_log_file.PNG diff --git a/docs/images/zh/IDF_tools_console.png b/docs_readme/images/zh/IDF_tools_console.png similarity index 100% rename from docs/images/zh/IDF_tools_console.png rename to docs_readme/images/zh/IDF_tools_console.png diff --git a/docs/images/zh/ToolsManager/git_python_selection.png b/docs_readme/images/zh/ToolsManager/git_python_selection.png similarity index 100% rename from docs/images/zh/ToolsManager/git_python_selection.png rename to docs_readme/images/zh/ToolsManager/git_python_selection.png diff --git a/docs/images/zh/ToolsManager/install_tools_manager.png b/docs_readme/images/zh/ToolsManager/install_tools_manager.png similarity index 100% rename from docs/images/zh/ToolsManager/install_tools_manager.png rename to docs_readme/images/zh/ToolsManager/install_tools_manager.png diff --git a/docs/images/zh/ToolsManager/manage_tools_installation.png b/docs_readme/images/zh/ToolsManager/manage_tools_installation.png similarity index 100% rename from docs/images/zh/ToolsManager/manage_tools_installation.png rename to docs_readme/images/zh/ToolsManager/manage_tools_installation.png diff --git a/docs/images/zh/ToolsManager/select_or_download_new_esp_idf.png b/docs_readme/images/zh/ToolsManager/select_or_download_new_esp_idf.png similarity index 100% rename from docs/images/zh/ToolsManager/select_or_download_new_esp_idf.png rename to docs_readme/images/zh/ToolsManager/select_or_download_new_esp_idf.png diff --git a/docs/images/zh/change_language.png b/docs_readme/images/zh/change_language.png similarity index 100% rename from docs/images/zh/change_language.png rename to docs_readme/images/zh/change_language.png diff --git a/docs/images/zh/cmake_editor_preferences.png b/docs_readme/images/zh/cmake_editor_preferences.png similarity index 100% rename from docs/images/zh/cmake_editor_preferences.png rename to docs_readme/images/zh/cmake_editor_preferences.png diff --git a/docs/images/zh/esp_idf_dir.png b/docs_readme/images/zh/esp_idf_dir.png similarity index 100% rename from docs/images/zh/esp_idf_dir.png rename to docs_readme/images/zh/esp_idf_dir.png diff --git a/docs/images/zh/espidf_download.png b/docs_readme/images/zh/espidf_download.png similarity index 100% rename from docs/images/zh/espidf_download.png rename to docs_readme/images/zh/espidf_download.png diff --git a/docs/images/zh/export_log.png b/docs_readme/images/zh/export_log.png similarity index 100% rename from docs/images/zh/export_log.png rename to docs_readme/images/zh/export_log.png diff --git a/docs/images/zh/idf_terminal.png b/docs_readme/images/zh/idf_terminal.png similarity index 100% rename from docs/images/zh/idf_terminal.png rename to docs_readme/images/zh/idf_terminal.png diff --git a/docs/images/zh/idf_update_site_install.png b/docs_readme/images/zh/idf_update_site_install.png similarity index 100% rename from docs/images/zh/idf_update_site_install.png rename to docs_readme/images/zh/idf_update_site_install.png diff --git a/docs/images/zh/sizeanalysis_details.png b/docs_readme/images/zh/sizeanalysis_details.png similarity index 100% rename from docs/images/zh/sizeanalysis_details.png rename to docs_readme/images/zh/sizeanalysis_details.png diff --git a/docs/images/zh/sizeanalysis_overview.png b/docs_readme/images/zh/sizeanalysis_overview.png similarity index 100% rename from docs/images/zh/sizeanalysis_overview.png rename to docs_readme/images/zh/sizeanalysis_overview.png