Skip to content

Commit

Permalink
docs(component): Improve Arduino as component documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasssvaz committed Jun 3, 2024
1 parent 8b4c130 commit 80d1f78
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions docs/en/esp-idf_component.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,17 @@
Arduino as an ESP-IDF component
###############################

This method is recommended for advanced users. To use this method, you will need to have the ESP-IDF toolchain installed.

For a simplified method, see `Installing using Boards Manager <https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-boards-manager>`_.
About
-----

ESP32 Arduino lib-builder
-------------------------
You can use the Arduino framework as an ESP-IDF component. This allows you to use the Arduino framework in your ESP-IDF projects with the full flexibility of the ESP-IDF.

If you don't need any modifications in the default Arduino ESP32 core, we recommend you to install using the Boards Manager.

Arduino Lib Builder is the tool that integrates ESP-IDF into Arduino. It allows you to customize the default settings used by Espressif and try them in Arduino IDE.
This method is recommended for advanced users. To use this method, you will need to have the ESP-IDF toolchain installed.

For more information see `Arduino lib builder <https://github.com/espressif/esp32-arduino-lib-builder>`_
For a simplified method, see `Installing using Boards Manager <https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-boards-manager>`_.

If you plan to use these modified settings multiple times, for different projects and targets, you can recompile the Arduino core with the new settings using the Arduino Static Library Builder.
For more information, see the `Lib Builder documentation <lib_builder.html>`_.

Installation
------------
Expand Down

0 comments on commit 80d1f78

Please sign in to comment.