From 4e3523c212375ef65256d09506ee89425dbf5958 Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Tue, 2 Jul 2024 18:46:29 -0300 Subject: [PATCH] docs(lib-builder): Add instructions to use the UI (#9977) --- docs/en/lib_builder.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/en/lib_builder.rst b/docs/en/lib_builder.rst index fb1a9b189ee..906188c8044 100644 --- a/docs/en/lib_builder.rst +++ b/docs/en/lib_builder.rst @@ -181,6 +181,26 @@ Specify additional configs to be applied. ex. 'qio 80m' to compile for QIO Flash ./build.sh -t esp32 -b idf_libs qio 80m +User Interface +-------------- + +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 has mouse support and can be pre-configured using command line arguments. +For more information and troubleshooting, check `the documentation `_. + +To use the terminal user interface, make sure to have ``python>=3.9``, all the previous dependencies and install the ``textual`` library: + +.. code-block:: bash + + pip install --user textual + +You can then run the UI using the following command: + +.. code-block:: bash + + ./tools/config_editor/app.py + Docker Image ------------