adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(lib-builder): Add missing requirements and examples (#10040)

Browse source
This commit is contained in:
Lucas Saavedra Vaz 2024-07-17 10:04:55 -03:00 committed by GitHub
parent e5ea4da382
commit 690bdb511d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/en/lib_builder.rst
View file

@ -5,7 +5,7 @@ Library Builder
About About
----- -----
Espressif provides a `tool <https://github.com/espressif/esp32-arduino-lib-builder>`_ to simplify building your own compiled libraries for use in Arduino IDE (or your favorite IDE). Espressif provides a macOS and Linux `tool <https://github.com/espressif/esp32-arduino-lib-builder>`_ to simplify building your own compiled libraries for use in Arduino IDE (or your favorite IDE).
This tool can be used to change the project or a specific configuration according to your needs. This tool can be used to change the project or a specific configuration according to your needs.
@ -184,9 +184,12 @@ Specify additional configs to be applied. ex. 'qio 80m' to compile for QIO Flash
User Interface User Interface
-------------- --------------
There is also a terminal user interface that can be used to configure the libraries to be compiled. Starting from ``arduino-esp32`` version 3.0.0 (IDF v5.1), there is also a terminal user interface that can be used
to configure the libraries to be compiled.
It allows the user to select the targets to compile, change the configuration options and compile the libraries. It allows the user to select the targets to compile, change the configuration options and compile the libraries.
It has mouse support and can be pre-configured using command line arguments. It has mouse support and can be pre-configured using command line arguments.
For more information and troubleshooting, check `the documentation <https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/config_editor/README.md>`_. For more information and troubleshooting, check `the documentation <https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/config_editor/README.md>`_.
To use the terminal user interface, make sure to have ``python>=3.9``, all the previous dependencies and install the ``textual`` library: To use the terminal user interface, make sure to have ``python>=3.9``, all the previous dependencies and install the ``textual`` library:
@ -214,7 +217,7 @@ The current supported architectures by the Docker image are:
.. note:: .. note::
Building the libraries using the Docker image is much slower than building them natively on the host machine. Building the libraries using the Docker image is much slower than building them natively on the host machine.
It is recommended to use the Docker image only when the host machine does not meet the requirements for building the libraries. It is recommended to use the Docker image only when the host machine does not meet the requirements for building the libraries (e.g., building on Windows).
Tags Tags
**** ****