Unverified Commit 4e3523c2 authored by Lucas Saavedra Vaz's avatar Lucas Saavedra Vaz Committed by GitHub

docs(lib-builder): Add instructions to use the UI (#9977)

parent 762d1a0f
......@@ -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 <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:
.. 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
------------
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment