Skip to content

Commit 9a904c7

Browse files
committed
updated readme and some minor fixes
1 parent ca3e158 commit 9a904c7

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,7 @@ else if (environment.containsKey("Path"))
646646
}
647647

648648
stringBuilder.append(Messages.MissingToolsValidationMessage_B);
649+
stringBuilder.append(System.lineSeparator());
649650
stringBuilder.append(Messages.MissingToolsValidationLink);
650651

651652
manageToolsInstallationWizardPage.getShell().getDisplay().asyncExec(() -> {

bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/messages.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,4 @@ FilterTargetBoxToolTip=Filter the tools based on the target selection of ESP chi
109109
ShowAvailableVersionsOnlyToolTip=Shows the versions that are available already and downloaded. The versions should be in the espressif home directory to be visible with this.
110110
MissingToolsValidationMessage_A=Following required tools are missing:
111111
MissingToolsValidationMessage_B=Please visit the Link below to see configuration for these tools
112-
MissingToolsValidationLink=
112+
MissingToolsValidationLink=https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/MissingToolsManualPathUpdateGuide.md
Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Installing Missing Tools and Updating Path
22

3-
Some tools are required as mandatory for the IDF and must be installed manually on Linux and MAC for windows the tools installation in the IDF-Eclipse Plugin takes care of them. Please vist [this](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html) link to first install them respective to your platform.
3+
Some tools are required as mandatory for the IDF and must be installed manually or must be selected when you are using the tools installation wizard on Linux and MAC and only selected recommended tools for windows these tools installation are mandatory and are selected with recommended tools.
44

5-
Once you have installed the required tools you can move to the next step.
6-
The `PATH` in the IDE is independent of the system's `PATH` variable so we need to configure it.<br/>
7-
8-
We will be using CMake as an example but you need to make sure to follow the steps below for all the tools you have installed from the previous link.
5+
If you have these tools already present on your system you can skip the first step and continue from the second step.
6+
1. In case you want to manually install these tools to the system first please vist [this](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html) link to install them respective to your platform.
97

10-
Run the following command to find out the install location of the tools
8+
*Once you have installed the required tools you can move to the next step.
9+
The `PATH` in the IDE is independent of the system's `PATH` variable so we need to configure it.<br/>*
10+
*We will be using CMake as an example but you need to make sure to follow the steps below for all the tools you have installed from the previous link.*
1111

12-
For CMake `which cmake` This will output the path to the directory where the CMake is installed. If you dont get the path it could mean a trouble with the path in your terminal or installation please consult the documentation again for the installation and correct configuration of the PATH for your system. Your output may look something like this
12+
2. Run the following command to find out the install location of the tools. For CMake `which cmake` This will output the path to the directory where the CMake is installed. If you dont get the path it could mean a trouble with the path in your terminal or installation please consult the documentation again for the installation and correct configuration of the PATH for your system. Your output may look something like this
1313
<br/>
1414
`/opt/homebrew/bin/cmake`
1515
<br/>
@@ -18,18 +18,19 @@ We need to copy the path for the directory in which the CMake is present. So the
1818

1919
Once that is copied you can head over to the IDE.
2020

21-
- Open Eclipse Settings and Go to `C/C++ -> Build -> Environment`. You will see these variables if you have installed the tools.
21+
3. Open Settings and Go to `C/C++ -> Build -> Environment`. You will see these variables if you have installed the tools.
2222
![](images/ToolsValidation/EnvSettings.png)
2323

2424
<br/>
2525

26-
- Select the `PATH` variable and click `Edit...`<br/>
26+
4. Select the `PATH` variable and click `Edit...`<br/>
2727
![](images/ToolsValidation/PathVarEdit.png)
2828

29-
- Now paste the path that we previously copeid `/opt/homebrew/bin` at the start of the current path and place a colon `:` after that. Your original `PATH` value will always come after the path you have copied. It should look something like this. <br/>
29+
5. Now paste the path that we previously copeid `/opt/homebrew/bin` at the start of the current path and place a colon `:` after that. Your original `PATH` value will always come after the path you have copied. It should look something like this. <br/>
3030
![](images/ToolsValidation/PathVarEdited.png)
3131
<br/>
3232

33+
3334
Now as stated previously this was only for cmake you need to find the install locations of the other required tools and add them in the same way to the `PATH`. After you have done that you can click `OK` and then click `Apply and Close`.
3435

3536
Once you have configured these correctly you should be able to build the projects.

0 commit comments

Comments
 (0)