arduino/arduino-esp32
1
0
Fork 0
mirror of https://github.com/espressif/arduino-esp32 synced 2024-09-21 10:28:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Lucas Saavedra Vaz 2024-07-02 18:46:29 -03:00 committed by GitHub
parent 762d1a0f69
commit 4e3523c212
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/en/lib_builder.rst
View File

@ -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
------------