Skip to content

Commit 4e3523c

Browse files
authored
docs(lib-builder): Add instructions to use the UI (espressif#9977)
1 parent 762d1a0 commit 4e3523c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/en/lib_builder.rst

+20
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,26 @@ Specify additional configs to be applied. ex. 'qio 80m' to compile for QIO Flash
181181
182182
./build.sh -t esp32 -b idf_libs qio 80m
183183
184+
User Interface
185+
--------------
186+
187+
There is also a terminal user interface that can be used to configure the libraries to be compiled.
188+
It allows the user to select the targets to compile, change the configuration options and compile the libraries.
189+
It has mouse support and can be pre-configured using command line arguments.
190+
For more information and troubleshooting, check `the documentation <https://github.com/espressif/esp32-arduino-lib-builder/blob/master/tools/config_editor/README.md>`_.
191+
192+
To use the terminal user interface, make sure to have ``python>=3.9``, all the previous dependencies and install the ``textual`` library:
193+
194+
.. code-block:: bash
195+
196+
pip install --user textual
197+
198+
You can then run the UI using the following command:
199+
200+
.. code-block:: bash
201+
202+
./tools/config_editor/app.py
203+
184204
Docker Image
185205
------------
186206

0 commit comments

Comments
 (0)