Merge branch 'contrib/github_pr_15944' into 'master'

Update CLion documentation page (GitHub PR)

Closes IDFGH-15285

See merge request espressif/esp-idf!39258
This commit is contained in:
Krzysztof Budzynski
2025-05-30 15:04:25 +08:00
2 changed files with 32 additions and 14 deletions

View File

@@ -1,28 +1,37 @@
.. _clion: .. _clion:
:link_to_translation:`zh_CN:[中文]`
CLion CLion
##### #####
:link_to_translation:`zh_CN:[中文]`
What Is CLion? What Is CLion?
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
`CLion <https://www.jetbrains.com/clion/>`__ is a cross-platform integrated Development Environment (IDE) for C and C++ programming. CLion also provides dedicated support for ESP-IDF, allowing developers to seamlessly work with the ESP-IDF framework. `CLion <https://www.jetbrains.com/clion/>`__ is a cross-platform integrated development environment (IDE) for C and C++ programming. It provides dedicated support for ESP-IDF, allowing developers to work seamlessly with the ESP-IDF framework.
Starting with v2025.1.1, `CLion is available at no cost <https://blog.jetbrains.com/clion/2025/05/clion-is-now-free-for-non-commercial-use/>`__ if youre using it to contribute to open-source projects, learn or teach C/C++, develop an application for personal use, or work on other non-commercial projects.
Installation Installation
~~~~~~~~~~~~ ~~~~~~~~~~~~
To install CLion, please follow the instructions provided in `Install CLion <https://www.jetbrains.com/help/clion/installation-guide.html>`__ for your operating system (Windows, macOS, or Linux). You can download CLion:
- as a `standalone version <https://www.jetbrains.com/clion/download/>`__, via `Toolbox App <https://www.jetbrains.com/toolbox-app/>`__.
- or as a snap package if youre using Ubuntu.
To learn about the required toolchains, check this `documentation <https://www.jetbrains.com/help/clion/installation-guide.html#toolchain-reqs>`__.
Configuration Configuration
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
To configure an ESP-IDF project in CLion, please refer to the guide on `Configure an ESP CMake project in CLion <https://www.jetbrains.com/help/clion/esp-idf.html#cmake-setup>`__. This guide will walk you through the necessary steps to set up your project properly. To configure an ESP-IDF project in CLion, follow the `Working with ESP-IDF in CLion <https://developer.espressif.com/blog/clion/#configuring-an-esp-idf-project>`__ tutorial. It provides detailed instructions on how to configure a project, build an application, flash it to a board, and debug it. You can also refer to `CLion's ESP-IDF documentation <https://www.jetbrains.com/help/clion/esp-idf.html>`__.
Resources Resources
~~~~~~~~~ ~~~~~~~~~
For more information about CLion and ESP-IDF integration, please refer to the following resource: For more information about the features and integrations CLion provides for embedded developers, refer to the following resources:
- `CLion Documentation <https://www.jetbrains.com/help/clion/>`__: The official documentation for CLion provides detailed information on various aspects of the IDE, including ESP-IDF integration. - `Embedded development support <https://www.jetbrains.com/help/clion/embedded-overview.html>`__: An overview of how you can use CLion as your embedded development IDE.
- `Debug servers <https://www.jetbrains.com/help/clion/debug-servers.html>`__: A new feature that provides a convenient way to configure and use a debug server with various build targets, including those for ESP-IDF.
- `PlatformIO integration <https://www.jetbrains.com/help/clion/platformio.html>`__: A detailed guide on how to work with the PlatformIO framework, using the `PlatformIO for CLion <https://plugins.jetbrains.com/plugin/13922-platformio-for-clion>`__ plugin.

View File

@@ -5,24 +5,33 @@ CLion
:link_to_translation:`en:[English]` :link_to_translation:`en:[English]`
CLion是什么 CLion 是什么?
~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
`CLion <https://www.jetbrains.com/clion/>`__用于 C 和 C++ 编程的跨平台集成开发环境 (IDE)。CLion 还提供了专门支持 ESP-IDF 的功能,使开发人员能够无缝使用 ESP-IDF 框架 `CLion <https://www.jetbrains.com/clion/>`__一款跨平台的 C/C++ 集成开发环境 (IDE),它支持 ESP-IDF 框架,为开发者提供无缝的开发体验
从 v2025.1.1 版本开始,`CLion 对以下用途免费开放 <https://blog.jetbrains.com/zh-hans/clion/2025/05/clion-is-now-free-for-non-commercial-use/#/>`__:开源项目贡献、学习或教学 C/C++、个人应用程序开发、其他非商业项目。
安装 安装
~~~~ ~~~~
安装 CLion请参考 `CLion 安装指南 <https://www.jetbrains.com/help/clion/installation-guide.html>`__可根据操作系统Windows, macOS, or Linux选择适用的版本。 可以通过以下方式下载 CLion
- 通过 `Toolbox App <https://www.jetbrains.com/zh-cn/toolbox-app/#/>`__ 下载 `独立安装版 <https://www.jetbrains.com/zh-cn/clion/download/#/>`__
- 或以 snap 软件包形式获取 CLion适用于 Ubuntu 系统)。
要了解所需的工具链,请参阅 `相关文档 <https://www.jetbrains.com/help/clion/installation-guide.html#toolchain-reqs>`__
配置 配置
~~~~ ~~~~
要在 CLion 中配置一个 ESP-IDF 项目,请参 `在 CLion 中配置 ESP CMake 项目 <https://www.jetbrains.com/help/clion/esp-idf.html#cmake-setup>`__。本指南将带您逐步完成配置项目的必要步骤 要在 CLion 中配置 ESP-IDF 项目,请参 `在 CLion 中使用 ESP-IDF <https://developer.espressif.com/blog/clion/#configuring-an-esp-idf-project>`__ 教程。该教程详细讲解了如何配置项目、构建应用程序、烧录至开发板以及进行调试。还可以参考 `CLion 的 ESP-IDF 文档 <https://www.jetbrains.com/help/clion/esp-idf.html>`__
资源 资源
~~~~ ~~~~
有关 CLion 和 ESP-IDF 集成的更多信息,请参考以下资源: 如需了解 CLion 为嵌入式开发提供的功能和集成支持,请参考以下资源:
- `CLion 文档 <https://www.jetbrains.com/help/clion/>`__ CLion 官方文档提供了有关 IDE 各方面内容的详细信息,包括 ESP-IDF 集成 - `嵌入式开发支持 <https://www.jetbrains.com/help/clion/embedded-overview.html>`__概述如何将 CLion 用作嵌入式开发 IDE
- `调试服务器 <https://www.jetbrains.com/help/clion/debug-servers.html>`__:一项新功能,可便捷地配置和使用调试服务器,支持包括 ESP-IDF 在内的多种构建目标。
- `PlatformIO 集成 <https://www.jetbrains.com/help/clion/platformio.html>`__:详细指南,介绍如何使用 `CLion 的 PlatformIO 插件 <https://plugins.jetbrains.com/plugin/13922-platformio-for-clion>`__ 搭配 PlatformIO 框架进行开发。