doc file and images for user guide added

espressif · Sep 14, 2023 · a1d1bb8 · a1d1bb8
1 parent 389bf4f
commit a1d1bb8
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 0 deletions.
diff --git a/docs/MissingToolsManualPathUpdateGuide.md b/docs/MissingToolsManualPathUpdateGuide.md
@@ -0,0 +1,35 @@
+# 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.
+
+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.<br/>
+
+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.
+
+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
+<br/>
+`/opt/homebrew/bin/cmake`
+<br/>
+We need to copy the path for the directory in which the CMake is present. So the path you will copy will look like this `/opt/homebrew/bin`
+<br/>
+
+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.
+![](images/ToolsValidation/EnvSettings.png)
+
+<br/>
+
+- Select the `PATH` variable and click `Edit...`<br/>
+![](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. <br/>
+![](images/ToolsValidation/PathVarEdited.png)
+<br/>
+
+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.
diff --git a/docs/images/ToolsValidation/EnvSettings.png b/docs/images/ToolsValidation/EnvSettings.png
diff --git a/docs/images/ToolsValidation/PathVarEdit.png b/docs/images/ToolsValidation/PathVarEdit.png
diff --git a/docs/images/ToolsValidation/PathVarEdited.png b/docs/images/ToolsValidation/PathVarEdited.png