-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs migration #1076
Docs migration #1076
Changes from 2 commits
5c88348
3a622cd
891c117
194661f
4acd222
d4ec1e6
33f0805
bc2c72a
3bd4692
e00ee9e
625f177
697dfc5
4413040
31bc349
2b13a9c
1539e0c
af86d40
4316a0f
539bc13
f56fbf6
7a9b6dc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,22 @@ | ||
Prerequisites | ||
=============================== | ||
The minimum requirements for running the Espressif-IDE are below. | ||
The Espressif-IDE is a development environment for Espressif chips using the ESP-IDF framework. It is designed to make development easy and straightforward. This document lists the requirements for installing and running the Espressif-IDE. | ||
|
||
Software Prerequisites | ||
----------------------- | ||
The minimum requirements for running the Espressif-IDE are listed below. | ||
|
||
- `Java 17 <https://www.oracle.com/technetwork/java/javase/downloads/index.html>`_ and above. | ||
- `Python 3.8 <https://www.python.org/downloads/>`_ and above. | ||
- `Python 3.12 <https://www.python.org/downloads/>`_ and above. | ||
- `Git <https://git-scm.com/downloads>`_. | ||
- Install the following ESP-IDF `Prerequisites <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html#step-1-install-prerequisites>`_. | ||
|
||
.. note:: | ||
Ensure that Java, Python, and Git are correctly set up and available in the system's PATH environment variable. | ||
Comment on lines
+23
to
+24
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Enhance PATH setup instructions The note about PATH setup could be more helpful by:
|
||
|
||
|
||
Note: Make sure Java, Python and Git are available on the environment PATH. | ||
Hardware Prerequisites | ||
----------------------- | ||
- A computer running Windows, Linux, or macOS | ||
- An ESP32 development board with a USB to serial interface and/or debug port | ||
- A USB cable (data + power) compatible with your development board |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,130 @@ | ||||||
.. _windowsofflineinstaller: | ||||||
|
||||||
Installing Espressif-IDE by Windows Offline Installer | ||||||
====================================================== | ||||||
|
||||||
Espressif-IDE Installer (All-in-One) is an offline installer and it comes with all the required components to work with the ESP-IDF Application development. | ||||||
|
||||||
The installer deploys the following components: | ||||||
|
||||||
- Embedded Python | ||||||
- Cross-compilers | ||||||
- OpenOCD | ||||||
- CMake and Ninja build tools | ||||||
- ESP-IDF | ||||||
- Espressif-IDE | ||||||
- Amazon Corretto OpenJDK | ||||||
|
||||||
As Installer bundles, all the required components and tools including stable esp-idf so people behind corporate firewalls can use the whole solution out-of-box. This also configures all the required build environment variables and tool paths as you launch the IDE. All you could do is to get started with your project directly without manually configuring anything. This will give you a big boost to your productivity! | ||||||
|
||||||
More details about the standard setup of toolchain for Windows can be found in the `windows-setup <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html>`_. | ||||||
|
||||||
Download | ||||||
-------- | ||||||
|
||||||
You can download the latest version of the installer from `this <https://dl.espressif.com/dl/esp-idf/>`_ and run the installer. You can find installer name with `espressif-ide-setup-2.10.0-with-esp-idf-5.0.1` or similar name based on the version of the installer and the version of the ESP-IDF. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Improve download section maintainability and clarity. The current download instructions have several areas for improvement:
-You can download the latest version of the installer from `this <https://dl.espressif.com/dl/esp-idf/>`_ and run the installer. You can find installer name with `espressif-ide-setup-2.10.0-with-esp-idf-5.0.1` or similar name based on the version of the installer and the version of the ESP-IDF.
+You can download the latest version of the installer from the `Espressif Download Center <https://dl.espressif.com/dl/esp-idf/>`_. Look for an installer named ``espressif-ide-setup-<IDE_VERSION>-with-esp-idf-<IDF_VERSION>`` (e.g., ``espressif-ide-setup-2.10.0-with-esp-idf-5.0.1``). Choose the version that matches your development requirements. 📝 Committable suggestion
Suggested change
|
||||||
|
||||||
Choose the Installer as shown below. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_0.png | ||||||
|
||||||
Installation | ||||||
------------ | ||||||
|
||||||
The installer is an executable file with .exe extension. You can run the installer by double-clicking on it. | ||||||
|
||||||
The installer will guide you through the installation process. Please find the step-by-step guide below. | ||||||
|
||||||
Step 1: Choose Language | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
Select language for the installer and click Ok. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_1.png | ||||||
:alt: drawing | ||||||
Comment on lines
+42
to
+43
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Improve image accessibility and consistency. Several images lack meaningful alt text, which is important for accessibility. Additionally, only the last image has a width specification. For each image, add descriptive alt text and consider standardizing image widths. Example: - :alt: drawing
+ :alt: Language selection dialog showing available languages
+ :width: 400 Also applies to: 51-52, 57-58, 63-64, 71-72, 79-82, 87-90, 97-98, 105-106, 113-114, 118-119, 128-130 |
||||||
|
||||||
Step 2: Accept the product license agreement | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
Read through the product license agreement, and then select `I accept the agreement`. You must accept the product license in order to continue with the installation. Continue by clicking Next. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_2.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 3: Pre-installation checks | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_3.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 4: Choose the installation directory | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_4.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 5: Select Components to Install | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
By default all the components are selected. You can deselect any component if you don't want to install it. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_5.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 6: Review the installation summary | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
A review summary is presented before the Espressif-IDE and others are installed. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_6.png | ||||||
:alt: drawing | ||||||
.. image:: ../../media/windows-installation/ide_windows_installer_7.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 6: Finalize the installation | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix step numbering in installation steps. There's a duplicate "Step 6" in the installation steps. This should be "Step 7", and subsequent steps should be renumbered accordingly. -Step 6: Finalize the installation
+Step 7: Finalize the installation 📝 Committable suggestion
Suggested change
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_8.png | ||||||
:alt: drawing | ||||||
.. image:: ../../media/windows-installation/ide_windows_installer_9.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 7: Launch Espressif-IDE | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
Launch Espressif-IDE by double-clicking on the icon. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_10.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 8: Choose Espressif-IDE Workspace | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
It's advised to select a workspace directory outside the Espressif-IDE Installer folder. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_11.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 9: Espressif-IDE Workbench | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
As soon as you launch the Espressif-IDE, it will automatically configure the required environment variables and launch the Welcome page. You can close the Welcome page. You don't need to run any additional install tools from the IDE. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_12.png | ||||||
:alt: drawing | ||||||
|
||||||
You can verify the CDT Build environment variables from the Eclipse Preferences. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_13.png | ||||||
:alt: drawing | ||||||
|
||||||
Step 10: Build Your First Project | ||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
||||||
As IDE already configured with all the required environment variables, you can start with your project. | ||||||
|
||||||
You can find more details for creating a project in the `New Project <https://github.com/espressif/idf-eclipse-plugin#create-a-new-project>`_ section of the documentation. | ||||||
|
||||||
.. image:: ../../media/windows-installation/ide_windows_installer_14.png | ||||||
:alt: drawing | ||||||
:width: 400 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix incomplete download URL.
The download URL for the Windows Installer appears to be incomplete. Please update it with the correct full URL.
Additionally, consider adding version information to help users identify the appropriate installer version.