Merge branch 'docs/update_get_started_for_eim_download' into 'master'

docs: update get started for downloading eim

See merge request espressif/esp-idf!45714
This commit is contained in:
Wang Ning
2026-03-10 09:58:29 +08:00
11 changed files with 170 additions and 60 deletions
@@ -2,6 +2,8 @@
在 Linux 或 macOS 上通过命令行构建项目
*****************************************************
:link_to_translation:`en:[English]`
本指南将介绍如何使用命令行在 {IDF_TARGET_NAME} 上创建新项目,构建、烧录和监控设备输出。
+15 -9
View File
@@ -2,7 +2,7 @@
在 Linux 上安装 ESP-IDF 及工具链
************************************************
:link_to_translation:`zh_CN:[中文]`
:link_to_translation:`en:[English]`
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 Linux 发行版(例如 Ubuntu)上安装 ESP-IDF 及其所需工具。
@@ -22,7 +22,7 @@
ESP-IDF 要求 Python 版本至少为 3.10。
但如需使用 EIM 进行 `离线安装 <https://docs.espressif.com/projects/idf-im-ui/en/latest/offline_installation.html>`_,则必须使用 **Python 3.11 或更高版本**。
EIM 所需的 Python 版本,请参考 `EIM 文档 <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_。
第二步:安装 EIM
@@ -30,13 +30,25 @@
您可以使用以下任一方法安装 EIM:
- `下载 EIM`_
- `通过 APT 安装(Debian 发行版)`_
- `通过 DNF 安装(RPM 发行版)`_
- `下载 EIM 安装包`_
通过 APT 或 DNF 安装 EIM 便于后续升级更新。
下载 EIM
~~~~~~~~~
.. figure:: ../../_static/get-started-eim-download.drawio.png
:alt: EIM 下载页面
:align: left
:width: 35%
:target: https://dl.espressif.com/dl/eim/
可选择下载在线或离线安装程序的图形用户界面 (GUI) 或命令行界面 (CLI) 版本。
.. _install-eim-linux-apt:
通过 APT 安装(Debian 发行版)
@@ -91,12 +103,6 @@
sudo dnf install eim-cli
下载 EIM 安装包
~~~~~~~~~~~~~~~~
您也可以从 `Espressif 下载页面 <https://dl.espressif.com/dl/eim/>`__ 下载适用于 Linux 的 EIM 安装包,该页面提供了 CLI 和 GUI 版本的在线和离线安装程序。
第三步:使用 EIM 安装 ESP-IDF
=================================
+26 -9
View File
@@ -2,7 +2,7 @@
在 macOS 上安装 ESP-IDF 及工具链
************************************************
:link_to_translation:`zh_CN:[中文]`
:link_to_translation:`en:[English]`
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 macOS 上安装 ESP-IDF 及其所需工具。
@@ -24,13 +24,36 @@
ESP-IDF 要求 Python 版本至少为 3.10。
但如需使用 EIM 进行 `离线安装 <https://docs.espressif.com/projects/idf-im-ui/en/latest/offline_installation.html>`_,则必须使用 **Python 3.11 或更高版本**。
EIM 所需的 Python 版本,请参考 `EIM 文档 <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_。
第二步:安装 EIM
=======================
将 EIM 仓库添加到 Homebrew 中,以便后续使用 Homebrew 安装 EIM:
您可以使用以下任一方法安装 EIM:
- `下载 EIM`_
- `通过 Homebrew 安装 EIM`_
如果通过 Homebrew 安装 EIM,后续运行单个命令,即可轻松升级更新 EIM。
下载 EIM
~~~~~~~~~
.. figure:: ../../_static/get-started-eim-download.drawio.png
:alt: EIM 下载页面
:align: left
:width: 35%
:target: https://dl.espressif.com/dl/eim/
可选择下载在线或离线安装程序的图形用户界面 (GUI) 或命令行界面 (CLI) 版本。
通过 Homebrew 安装 EIM
~~~~~~~~~~~~~~~~~~~~~~~~~
将 EIM 仓库添加到 `Homebrew <https://brew.sh/>`__ 中,以便后续使用 Homebrew 安装 EIM:
.. code-block:: bash
@@ -48,12 +71,6 @@
brew install eim
.. note::
通过 Homebrew 安装 EIM 便于后续升级更新。
您也可以从 `Espressif 下载页面 <https://dl.espressif.com/dl/eim/>`__ 下载适用于 macOS 的 EIM 安装包,该页面提供了 CLI 和 GUI 版本的在线和离线安装程序。
第三步:使用 EIM 安装 ESP-IDF
==============================
+41 -13
View File
@@ -2,7 +2,7 @@
在 Windows 上安装 ESP-IDF 及工具链
************************************************
:link_to_translation:`zh_CN:[中文]`
:link_to_translation:`en:[English]`
本章节将介绍如何使用 ESP-IDF 安装管理器 (EIM) 在 Windows 上安装 ESP-IDF 及其所需工具。
@@ -11,29 +11,57 @@
本章节描述了 ESP-IDF v6.0 及以上版本的默认和推荐安装方式。ESP-IDF 仍支持 :doc:`Windows 上更新 ESP-IDF 的传统方法 <windows-setup-update-legacy>`。
第一步:安装 EIM
第一步:安装依赖包(可选)
==========================
安装 ESP-IDF 时,EIM 会自动检查所需的依赖包。如果检查到依赖包缺失,EIM 会在用户确认后自动安装缺失的依赖包。
如果自动安装失败,可以手动安装以下依赖包:
- `Git <https://git-scm.com/install/windows>`_
- `Python <https://www.python.org/downloads/windows/>`_
.. note::
Python 3.10 是 ESP-IDF 支持的最低版本。
EIM 所需的 Python 版本,请参考 `EIM 文档 <https://docs.espressif.com/projects/idf-im-ui/en/latest/prerequisites.html#python-version>`_。
第二步:安装 EIM
=================
通过 `WinGet <https://learn.microsoft.com/en-us/windows/package-manager/winget/>`__ 安装 EIM 的图形用户界面 (GUI) 或命令行界面 (CLI):
您可以使用以下任一方法安装 EIM:
- GUI:
.. code-block:: bash
- 下载 EIM
winget install Espressif.EIM
.. figure:: ../../_static/get-started-eim-download.drawio.png
:alt: EIM 下载页面
:align: left
:width: 35%
:target: https://dl.espressif.com/dl/eim/
- CLI:
.. code-block:: bash
可选择下载在线或离线安装程序的图形用户界面 (GUI) 或命令行界面 (CLI) 版本。
winget install Espressif.EIM-CLI
- 使用 `WinGet 包管理器 <https://learn.microsoft.com/zh-cn/windows/package-manager/>`_ 安装 EIM
.. note::
- 安装图形用户界面 (GUI) 或命令行界面 (CLI):
通过 WinGet 安装 EIM 便于后续升级更新。
- GUI:
您也可以从 `Espressif 下载页面 <https://dl.espressif.com/dl/eim/>`__ 下载适用于 Windows 的 EIM 安装包,该页面提供了 CLI 和 GUI 版本的在线和离线安装程序。
.. code-block:: bash
winget install Espressif.EIM
- CLI:
.. code-block:: bash
winget install Espressif.EIM-CLI
- 通过运行单个命令,轻松升级更新 EIM。
第二步:使用 EIM 安装 ESP-IDF
第三步:使用 EIM 安装 ESP-IDF
==============================
.. include:: eim-install-idf.rst
@@ -2,6 +2,8 @@
在 Windows 上通过命令行构建项目
********************************************
:link_to_translation:`en:[English]`
本指南将介绍如何使用命令行在 Windows 上创建 {IDF_TARGET_NAME} 项目,构建、烧录和监控设备输出。