diff --git a/docs/_static/platformio-logo.png b/docs/_static/platformio-logo.png new file mode 100644 index 000000000..012819a8f Binary files /dev/null and b/docs/_static/platformio-logo.png differ diff --git a/docs/en/resources.rst b/docs/en/resources.rst index 02a61cca1..f86daab1b 100644 --- a/docs/en/resources.rst +++ b/docs/en/resources.rst @@ -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 `_ is a place to ask questions and find community resources. * Check the `Issues `_ section on GitHub if you find a bug or have a feature request. Please check existing `Issues `_ before opening a new one. diff --git a/docs/en/third-party-tools/platformio.rst b/docs/en/third-party-tools/platformio.rst new file mode 100644 index 000000000..c875abc40 --- /dev/null +++ b/docs/en/third-party-tools/platformio.rst @@ -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 `__ +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 `_. + +A detailed overview of the PlatformIO ecosystem and its philosophy can be +found in `the official PlatformIO documentation `_. + +Installation +~~~~~~~~~~~~ + +* `PlatformIO IDE `_ + is a toolset for embedded C/C++ development available on Windows, macOS and Linux + platforms +* `PlatformIO Core (CLI) `_ + 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 `_. + +Tutorials +~~~~~~~~~ + +- `ESP-IDF and ESP32-DevKitC: debugging, unit testing, project analysis + `__ + +Project Examples +~~~~~~~~~~~~~~~~ + +Please check ESP-IDF page in `the official PlatformIO documentation `__ + +Next Steps +~~~~~~~~~~ + +Here are some useful links for exploring the PlatformIO ecosystem: + +- Learn more about `integrations with other IDEs/Text Editors `_ +- Get help from `PlatformIO community `_ diff --git a/docs/zh_CN/resources.rst b/docs/zh_CN/resources.rst index 509a66f93..39fafda33 100644 --- a/docs/zh_CN/resources.rst +++ b/docs/zh_CN/resources.rst @@ -3,6 +3,16 @@ **** :link_to_translation:`en:[English]` +.. toctree:: + :caption: 第三方工具 + :maxdepth: 2 + + third-party-tools/platformio + + +有用的链接 +########## + * 您可以在 `ESP32 论坛 `_ 中提出您的问题,访问社区资源。 * 您可以通过 GitHub 的 `Issues `_ 版块提交 bug 或功能请求。在提交新 Issue 之前,请先查看现有的 `Issues `_。 diff --git a/docs/zh_CN/third-party-tools/platformio.rst b/docs/zh_CN/third-party-tools/platformio.rst new file mode 100644 index 000000000..e3c015fe8 --- /dev/null +++ b/docs/zh_CN/third-party-tools/platformio.rst @@ -0,0 +1 @@ +.. include:: ../../en/third-party-tools/platformio.rst