Added basic documentation #28
Conversation
There was a problem hiding this comment.
Thanks @Hahihula for the PR. Could you please check the review comments.
docs/en/installation.rst
Outdated
| Installation of IDF | ||
| =============================== | ||
| Installing the ESP-IDF using EIM is straightforward. Simply open your preferred shell (we recommend PowerShell for Windows users) and run EIM, providing your installation preferences using any of the configuration <configuration> methods you choose. If you haven't provided all the necessary options, an interactive wizard will guide you through the remaining steps. | ||
|
|
||
| After Installation |
There was a problem hiding this comment.
Please describe the installation process of the eim tool in detail, including screenshots.
Also, explain what artifacts it will generate, where they will be stored, and how users should get started once the installation is complete.
docs/en/prerequisites.rst
Outdated
| Below are the minimum requirements for running the ESP-IDF Installation Manager. | ||
|
|
||
| Windows | ||
| ---------------- | ||
|
|
||
| - git | ||
| - cmake | ||
| - ninja | ||
| - python with pip capable of creating virtual environment and doing SSL requests | ||
|
|
There was a problem hiding this comment.
For Windows, Git and CMake are not prerequisites for installing eim, right? They are prerequisites for IDF, they were installed by eim.
There was a problem hiding this comment.
the prerequisites are always for the IDF as eim does not have any and as it's stated in the note, on windows we can take care of these if user wants to
There was a problem hiding this comment.
IMO, the better way to present this is -
To get started with ESP-IDF, you need Git, CMake, Ninja, and Python. The ESP-IDF Installation Manager will verify the required prerequisites on your system and install any that are missing.
For more details about ESP-IDF prerequisites, please refer to the ESP-IDF prerequisites documentation.
| - dfu-util | ||
| - cmake | ||
| - ninja | ||
| - python with pip capable of creating virtual environment and doing SSL requests |
There was a problem hiding this comment.
Mention only the prerequisites that are not installed by eim but are needed for IDF.
There was a problem hiding this comment.
we do not install any prerequisities on posix systems so all this are needed for some version of IDF
No description provided.