From 49b12c7f7edb7fef6280e2ff8b0e443cb630c8c4 Mon Sep 17 00:00:00 2001 From: Ali Azam Rana <85216275+alirana01@users.noreply.github.com> Date: Wed, 26 Jul 2023 10:16:08 +0200 Subject: [PATCH] updated readme and some minor fixes --- .../ui/tools/ToolsInstallationHandler.java | 1 + .../idf/ui/tools/messages.properties | 2 +- docs/MissingToolsManualPathUpdateGuide.md | 21 ++++++++++--------- 3 files changed, 13 insertions(+), 11 deletions(-) diff --git a/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java b/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java index d8141729a..448d6c0ac 100644 --- a/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java +++ b/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/ToolsInstallationHandler.java @@ -646,6 +646,7 @@ else if (environment.containsKey("Path")) } stringBuilder.append(Messages.MissingToolsValidationMessage_B); + stringBuilder.append(System.lineSeparator()); stringBuilder.append(Messages.MissingToolsValidationLink); manageToolsInstallationWizardPage.getShell().getDisplay().asyncExec(() -> { diff --git a/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/messages.properties b/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/messages.properties index bd697cd84..3ce48d71e 100644 --- a/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/messages.properties +++ b/bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/messages.properties @@ -109,4 +109,4 @@ FilterTargetBoxToolTip=Filter the tools based on the target selection of ESP chi ShowAvailableVersionsOnlyToolTip=Shows the versions that are available already and downloaded. The versions should be in the espressif home directory to be visible with this. MissingToolsValidationMessage_A=Following required tools are missing: MissingToolsValidationMessage_B=Please visit the Link below to see configuration for these tools -MissingToolsValidationLink= +MissingToolsValidationLink=https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/MissingToolsManualPathUpdateGuide.md diff --git a/docs/MissingToolsManualPathUpdateGuide.md b/docs/MissingToolsManualPathUpdateGuide.md index 52e8b36ab..f9384ecc5 100644 --- a/docs/MissingToolsManualPathUpdateGuide.md +++ b/docs/MissingToolsManualPathUpdateGuide.md @@ -1,15 +1,15 @@ # Installing Missing Tools and Updating Path -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. +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. -Once you have installed the required tools you can move to the next step. -The `PATH` in the IDE is independent of the system's `PATH` variable so we need to configure it.
- -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. +If you have these tools already present on your system you can skip the first step and continue from the second step. +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. -Run the following command to find out the install location of the tools +*Once you have installed the required tools you can move to the next step. +The `PATH` in the IDE is independent of the system's `PATH` variable so we need to configure it.
* +*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.* -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 +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
`/opt/homebrew/bin/cmake`
@@ -18,18 +18,19 @@ We need to copy the path for the directory in which the CMake is present. So the Once that is copied you can head over to the IDE. -- Open Eclipse Settings and Go to `C/C++ -> Build -> Environment`. You will see these variables if you have installed the tools. +3. Open Settings and Go to `C/C++ -> Build -> Environment`. You will see these variables if you have installed the tools. ![](images/ToolsValidation/EnvSettings.png)
-- Select the `PATH` variable and click `Edit...`
+4. Select the `PATH` variable and click `Edit...`
![](images/ToolsValidation/PathVarEdit.png) -- 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.
+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.
![](images/ToolsValidation/PathVarEdited.png)
+ 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`. Once you have configured these correctly you should be able to build the projects. \ No newline at end of file