Skip to content

Commit 43e6cbd

Browse files
doc: update on import debug launch configuration
1 parent 2924a5b commit 43e6cbd

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ IDF Eclipse Plugins aiming to provide better tooling capabilities, which simplif
2121
* [ Configuring CMake Toolchain ](#ConfigureCMakeToolchain)<br>
2222
* [ Configuring the flash arguments ](#customizeLaunchConfig)<br>
2323
* [ Upgrading IDF Eclipse Plugins ](#upgradePlugins)<br>
24+
* [ Importing an existing Debug launch configuration ](#importDebugLaunchConfig)<br>
2425
* [ Troubleshooting Guide](#troubleshooting)<br>
2526
* [ How to raise bugs ](#howToRaiseBugs)<br>
2627
* [ FAQ ](#faq)<br>
@@ -34,6 +35,8 @@ IDF Eclipse Plugins aiming to provide better tooling capabilities, which simplif
3435
* **ESP-IDF 4.0 and above** : Follow the download instructions from <a href ="https://github.com/espressif/esp-idf/releases">here</a>
3536
* **Git** : Get the latest git from <a href ="https://git-scm.com/downloads">here</a>
3637

38+
**Note:** Make sure Java, Python and Git are available on the system environment PATH.
39+
3740
<a name="GettingStarted"></a>
3841
# Getting started with the IDF Eclipse Plugins
3942
Eclipse provides two ways to install the IDF Plugins
@@ -181,6 +184,10 @@ CMake editor preferences can be controlled using `Eclipse > Preferences > CMakeE
181184
# Debugging the Project
182185
Please refer to <a href ="https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/jtag-debugging/index.html" > JTAG Debugging guide</a>
183186

187+
Predefined debug launch configuration files can be found <a href ="https://github.com/espressif/idf-eclipse-plugin/tree/master/resources/Debugging%20Launch%20Configurations" > here</a>. These can be used for reference.
188+
189+
Please refer to [Importing Debug Launch Configuration](#customizeLaunchConfig) section for importing the existing configuration files into Eclipse. Make sure to modify the debug launch configuraton project specific settings after importing.
190+
184191
<a name="configureEnvironmentVariables"></a>
185192
# Configuring Environment Variables
186193
Eclipse auto configure the required environment variables in the `Preferences > C/C++ Build > Environment` section If IDF Tools are installed using `Help` > `Espressif IDF Tools Manager` > `Install Tools` menu option.
@@ -307,7 +314,20 @@ If you've already installed IDF Eclipse Plugins using update site URL, you can g
307314
* If updates are found, select `Espressif IDF Plugins for Eclipse` and deselect all other items
308315
* Click `Next` to proceed with the installation
309316

310-
![](docs/images/update_plugins.png)
317+
![](docs/images/Update_plugins.png)
318+
319+
<a name="importDebugLaunchConfig"></a>
320+
# Importing an existing Debug launch configuration
321+
To import an existing launch configuration into Eclipse:
322+
* Select `Import...` from the `File` menu
323+
* In the Import dialog box, expand the `Run/Debug` group and select `Launch Configurations`
324+
* Click on `Next`
325+
* Click on `Browse...` to select the required location in the local file system
326+
* Select the folder containing the launch files and then click OK
327+
* Select the checkboxes for the required folder and launch file
328+
* If you are replacing an existing configuration with the same name then select `Overwrite existing launch configurations without warning`
329+
* Click on `Finish`
330+
311331

312332
<a name="howToRaiseBugs"></a>
313333
# How to raise bugs

0 commit comments

Comments
 (0)