Skip to content

Commit 9fbb3f8

Browse files
committed
Add readme
1 parent febe5fa commit 9fbb3f8

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

tools/config_editor/README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,24 @@
1-
# Configuration Editor
1+
# Arduino Static Libraries Configuration Editor
2+
3+
This is a simple application to configure the static libraries for the ESP32 Arduino core.
4+
It allows the user to select the targets to compile, change the configuration options and compile the libraries.
5+
6+
## Requirements
7+
- Python 3.9 or later
8+
- The "textual" library (install it using `pip install textual`)
9+
- The requirements from esp32-arduino-lib-builder
10+
11+
### WSL
12+
If you are using WSL, it is recommended to use the Windows Terminal to visualize the application. Otherwise, the application layout and colors might not be displayed correctly.
13+
The Windows Terminal can be installed from the Microsoft Store.
14+
15+
## Usage
16+
17+
Command line arguments:
18+
-t, --target <target> Target to be compiled. Choose from: all, esp32, esp32s2, esp32s3, esp32c2, esp32c3, esp32c6, esp32h2
19+
--copy, --no-copy Enable/disable copying the compiled libraries to arduino-esp32. Enabled by default
20+
-c, --arduino-path <path> Path to arduino-esp32 directory. Default: OS dependent
21+
-A, --arduino-branch <branch> Branch of the arduino-esp32 repository to be used
22+
-I, --idf-branch <branch> Branch of the ESP-IDF repository to be used
23+
-i, --idf-commit <commit> Commit of the ESP-IDF repository to be used
24+
-D, --debug-level <level> Debug level to be set to ESP-IDF. Choose from: default, none, error, warning, info, debug, verbose

0 commit comments

Comments
 (0)