Skip to content

Commit f0702ef

Browse files
committed
Improve documentation
1 parent 6bdcb04 commit f0702ef

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,29 @@ git clone https://github.com/espressif/esp32-arduino-lib-builder
1212
cd esp32-arduino-lib-builder
1313
./build.sh
1414
```
15+
16+
### Using the User Interface
17+
18+
You can more easily build the libraries using the user interface found in the `tools/config_editor/` folder.
19+
It is a Python script that allows you to select and edit the options for the libraries you want to build.
20+
The script has mouse support and can also be pre-configured using the same command line arguments as the `build.sh` script.
21+
To use it, follow these steps:
22+
23+
1. Make sure you have the required dependencies installed:
24+
- Python 3.9 or later
25+
- The [Textual](https://github.com/textualize/textual/) library
26+
- All the dependencies listed in the previous section
27+
28+
2. Execute the script `tools/config_editor/app.py` from any folder. It will automatically detect the path to the root of the repository.
29+
30+
3. Configure the compilation and ESP-IDF options as desired.
31+
32+
4. Click on the "Compile Static Libraries" button to start the compilation process.
33+
34+
5. The script will show the compilation output in a new screen. Note that the compilation process can take many hours, depending on the number of libraries selected and the options chosen.
35+
36+
6. If the compilation is successful and the option to copy the libraries to the Arduino Core folder is enabled, it will already be available for use in the Arduino IDE. Otherwise, you can find the compiled libraries in the `esp32-arduino-libs` folder alongside this repository.
37+
1538
### Documentation
1639

1740
For more information about how to use the Library builder, please refer to this [Documentation page](https://docs.espressif.com/projects/arduino-esp32/en/latest/lib_builder.html?highlight=lib%20builder)

tools/config_editor/app.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@
1313
Note that this application still needs the requirements from esp32-arduino-lib-builder to be installed.
1414
1515
Command line arguments:
16-
-t, --target <target> Target to be compiled. Choose from: all, esp32, esp32s2, esp32s3, esp32c2, esp32c3, esp32c6, esp32h2. Default: all
16+
-t, --target <target> Comma separated list of targets to be compiled.
17+
Choose from: all, esp32, esp32s2, esp32s3, esp32c2, esp32c3, esp32c6, esp32h2. Default: all except esp32c2
1718
--copy, --no-copy Enable/disable copying the compiled libraries to arduino-esp32. Enabled by default
1819
-c, --arduino-path <path> Path to arduino-esp32 directory. Default: OS dependent
1920
-A, --arduino-branch <branch> Branch of the arduino-esp32 repository to be used. Default: set by the build script
2021
-I, --idf-branch <branch> Branch of the ESP-IDF repository to be used. Default: set by the build script
2122
-i, --idf-commit <commit> Commit of the ESP-IDF repository to be used. Default: set by the build script
22-
-D, --debug-level <level> Debug level to be set to ESP-IDF. Choose from: default, none, error, warning, info, debug, verbose. Default: default
23+
-D, --debug-level <level> Debug level to be set to ESP-IDF.
24+
Choose from: default, none, error, warning, info, debug, verbose. Default: default
2325
2426
"""
2527

0 commit comments

Comments
 (0)