Skip to content

Commit 67837bb

Browse files
committed
feat: update README
1 parent d674d99 commit 67837bb

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ In comparison to the original [esp32-arduino-lib-builder](https://github.com/esp
2323

2424
* `release/*` is used to recompile the original SDK for a specified version.
2525
* `debug/*` is used to recompile debug versions based on a specified SDK version.
26-
* `high_perf/*` is used to recompile high performance versions based on a specified SDK version. It changes some configurations (as below) and can achieve higher performance in some cases, especially for avoiding [screen drifting](https://docs.espressif.com/projects/esp-faq/en/latest/software-framework/peripherals/lcd.html#why-do-i-get-drift-overall-drift-of-the-display-when-esp32-s3-is-driving-an-rgb-lcd-screen) when using RGB LCDs.
26+
* `high_perf/*` is used to recompile high performance versions based on a specified SDK version. It changes some configurations (as below) and can achieve higher performance in some cases, especially for avoiding [screen drifting](https://docs.espressif.com/projects/esp-faq/en/latest/software-framework/peripherals/lcd.html#why-do-i-get-drift-overall-drift-of-the-display-when-esp32-s3-is-driving-an-rgb-lcd-screen) when using RGB LCDs. (Only available for v3.x and above versions)
2727

2828
* For ESP32-S3 SoCs:
2929
* It changes the optimization level from `-Os` to `-O2` by enabling `CONFIG_COMPILER_OPTIMIZATION_PERF=y`.
@@ -40,11 +40,14 @@ In comparison to the original [esp32-arduino-lib-builder](https://github.com/esp
4040

4141
### Debug Versions
4242

43+
Due to the support of specifying the LOG level when compiling v3.x and above versions in esp32-arduino-lib-builder, the branches here are only used to compile debug versions of v2.x.
44+
4345
* [debug/v2.0.13](https://github.com/esp-arduino-libs/esp32-arduino-lib-builder/tree/release/v2.0.13)
44-
* [debug/v3.0.0-alpha3](https://github.com/esp-arduino-libs/esp32-arduino-lib-builder/tree/release/v3.0.0-alpha3)
4546

4647
### High Performance Versions
4748

49+
As only v3.x and above versions support the required high-performance configurations, the branches here are only used for compiling the high_perf version of v3.x.
50+
4851
* [high_perf/v3.0.0-alpha3](https://github.com/esp-arduino-libs/esp32-arduino-lib-builder/tree/high_perf/v3.0.0-alpha3)
4952

5053
## How to Use
@@ -85,17 +88,21 @@ In comparison to the original [esp32-arduino-lib-builder](https://github.com/esp
8588

8689
4. If you don't need to change the default configurations or just want to compile a specific target, follow the below steps:
8790

88-
* Click `Actions` and enter the `Manual Build SDK For the Specific Target` workflow.
91+
* Click `Actions`, here are two workflows, `Manual Build SDK For (v2) the Specific Target` is used to compile the v2.x version, and `Manual Build SDK For (v3) the Specific Target` is used to compile the v3.x version.
8992

90-
<img src="docs/_static/manual_step_1.png">
93+
<img src="docs/_static/manual_step_0_0.png">
9194

92-
* Click `Run workflow`, select the branch and the target, click `Run workflow`. Then the compilation process will start.
95+
* If you want to compile the **v2.x version**, click `Manual Build SDK For (v2) the Specific Target`, then click `Run workflow`. Here you can select the branch (only available for the `xx/v2.x.x` branches) and the target.
9396

94-
<img src="docs/_static/manual_step_2.png">
97+
<img src="docs/_static/manual_step_0_1.png">
9598

96-
<img src="docs/_static/manual_step_3.png">
99+
* If you want to compile the **v3.x version**, click `Manual Build SDK For (v3) the Specific Target`, then click `Run workflow`. Here you can select the branch (only available for the `xx/v3.x.x` branches), the target and log level. So there are no `debug/v3.x.x` branches, you can specify the log level when compiling.
97100

98-
5. After the compilation is complete, download the zip file from the `Artifacts`.
101+
<img src="docs/_static/manual_step_0_2.png">
102+
103+
* Then the compilation process will start. After it is complete, download the zip file from the `Artifacts`.
104+
105+
<img src="docs/_static/manual_step_3.png">
99106

100107
<img src="docs/_static/auto_step_7.png">
101108

docs/_static/manual_step_0_0.png

67.2 KB
Loading

docs/_static/manual_step_0_1.png

79.7 KB
Loading

docs/_static/manual_step_0_2.png

97.5 KB
Loading

0 commit comments

Comments
 (0)