Skip to content

Commit 690bdb5

Browse files
authored
docs(lib-builder): Add missing requirements and examples (espressif#10040)
1 parent e5ea4da commit 690bdb5

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/en/lib_builder.rst

+6-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Library Builder
55
About
66
-----
77

8-
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).
8+
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).
99

1010
This tool can be used to change the project or a specific configuration according to your needs.
1111

@@ -184,9 +184,12 @@ Specify additional configs to be applied. ex. 'qio 80m' to compile for QIO Flash
184184
User Interface
185185
--------------
186186

187-
There is also a terminal user interface that can be used to configure the libraries to be compiled.
187+
Starting from ``arduino-esp32`` version 3.0.0 (IDF v5.1), there is also a terminal user interface that can be used
188+
to configure the libraries to be compiled.
189+
188190
It allows the user to select the targets to compile, change the configuration options and compile the libraries.
189191
It has mouse support and can be pre-configured using command line arguments.
192+
190193
For more information and troubleshooting, check `the documentation <https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/config_editor/README.md>`_.
191194

192195
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:
214217

215218
.. note::
216219
Building the libraries using the Docker image is much slower than building them natively on the host machine.
217-
It is recommended to use the Docker image only when the host machine does not meet the requirements for building the libraries.
220+
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).
218221

219222
Tags
220223
****

0 commit comments

Comments
 (0)