Add new section about using ESP-IDF with PlatformIO
This adds a description of PlatformIO ecosystem, tutorials, examples Merges https://github.com/espressif/esp-idf/pull/5132
This commit is contained in:
parent
d5195d19ae
commit
bc397f8b7d
5 changed files with 81 additions and 0 deletions
BIN
docs/_static/platformio-logo.png
vendored
Normal file
BIN
docs/_static/platformio-logo.png
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 244 KiB |
|
@ -3,6 +3,16 @@ Resources
|
|||
*********
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
.. toctree::
|
||||
:caption: Third-Party Tools
|
||||
:maxdepth: 2
|
||||
|
||||
third-party-tools/platformio
|
||||
|
||||
|
||||
Useful Links
|
||||
############
|
||||
|
||||
* The `esp32.com forum <https://esp32.com/>`_ is a place to ask questions and find community resources.
|
||||
|
||||
* Check the `Issues <https://github.com/espressif/esp-idf/issues>`_ section on GitHub if you find a bug or have a feature request. Please check existing `Issues <https://github.com/espressif/esp-idf/issues>`_ before opening a new one.
|
||||
|
|
60
docs/en/third-party-tools/platformio.rst
Normal file
60
docs/en/third-party-tools/platformio.rst
Normal file
|
@ -0,0 +1,60 @@
|
|||
.. _platformio:
|
||||
|
||||
PlatformIO
|
||||
##########
|
||||
|
||||
.. image:: ../../_static/platformio-logo.png
|
||||
:target: https://platformio.org/?utm_source=docs.espressif.com
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
What is PlatformIO?
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
`PlatformIO <https://platformio.org/?utm_source=docs.espressif.com>`__
|
||||
is a cross-platform embedded development environment with out-of-the-box support
|
||||
for ESP-IDF.
|
||||
|
||||
Since ESP-IDF support within PlatformIO is not maintained by the Espressif team,
|
||||
please report any issues with PlatformIO directly to its developers in
|
||||
`the official PlatformIO repositories <https://github.com/platformio>`_.
|
||||
|
||||
A detailed overview of the PlatformIO ecosystem and its philosophy can be
|
||||
found in `the official PlatformIO documentation <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=docs.espressif.com>`_.
|
||||
|
||||
Installation
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=docs.espressif.com>`_
|
||||
is a toolset for embedded C/C++ development available on Windows, macOS and Linux
|
||||
platforms
|
||||
* `PlatformIO Core (CLI) <https://docs.platformio.org/en/latest/core/index.html?utm_source=docs.espressif.com>`_
|
||||
is a command-line tool that consists of multi-platform build system, platform and
|
||||
library managers and other integration components. It can be used with a variety of
|
||||
code development environments and allows integration with cloud platforms and web
|
||||
services
|
||||
|
||||
Configuration
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Please go through `the official PlatformIO configuration guide for ESP-IDF <https://docs.platformio.org/en/latest/frameworks/espidf.html?utm_source=docs.espressif.com#configuration>`_.
|
||||
|
||||
Tutorials
|
||||
~~~~~~~~~
|
||||
|
||||
- `ESP-IDF and ESP32-DevKitC: debugging, unit testing, project analysis
|
||||
<https://docs.platformio.org/en/latest/tutorials/espressif32/espidf_debugging_unit_testing_inspect.html?utm_source=docs.espressif.com>`__
|
||||
|
||||
Project Examples
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Please check ESP-IDF page in `the official PlatformIO documentation <https://docs.platformio.org/en/latest/frameworks/espidf.html?utm_source=docs.espressif.com#examples>`__
|
||||
|
||||
Next Steps
|
||||
~~~~~~~~~~
|
||||
|
||||
Here are some useful links for exploring the PlatformIO ecosystem:
|
||||
|
||||
- Learn more about `integrations with other IDEs/Text Editors <https://docs.platformio.org/en/latest/integration/ide/index.html?utm_source=docs.espressif.com>`_
|
||||
- Get help from `PlatformIO community <https://community.platformio.org/?utm_source=docs.espressif.com>`_
|
|
@ -3,6 +3,16 @@
|
|||
****
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
.. toctree::
|
||||
:caption: 第三方工具
|
||||
:maxdepth: 2
|
||||
|
||||
third-party-tools/platformio
|
||||
|
||||
|
||||
有用的链接
|
||||
##########
|
||||
|
||||
* 您可以在 `ESP32 论坛 <https://esp32.com/>`_ 中提出您的问题,访问社区资源。
|
||||
|
||||
* 您可以通过 GitHub 的 `Issues <https://github.com/espressif/esp-idf/issues>`_ 版块提交 bug 或功能请求。在提交新 Issue 之前,请先查看现有的 `Issues <https://github.com/espressif/esp-idf/issues>`_。
|
||||
|
|
1
docs/zh_CN/third-party-tools/platformio.rst
Normal file
1
docs/zh_CN/third-party-tools/platformio.rst
Normal file
|
@ -0,0 +1 @@
|
|||
.. include:: ../../en/third-party-tools/platformio.rst
|
Loading…
Reference in a new issue