Skip to content

Commit 0a33a10

Browse files
authored
Update all_clusters_app README (project-chip#14863)
The instructions currently customize the device via menuconfig. This bypasses the various customizations from the device specific defaults. Add a section to encourage users to start with the device specific defaults to avoid running into hard to debug run-time issues.
1 parent 64c8a60 commit 0a33a10

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

examples/all-clusters-app/esp32/README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,20 @@ To set IDF target, run set-target with one of the commands.
8484

8585
- Configuration Options
8686

87-
To choose from the different configuration options, run menuconfig.
87+
To build the default configuration (`sdkconfig.defaults`) skip to building the
88+
demo application.
89+
90+
To build a specific configuration (as an example `m5stack`):
91+
92+
$ rm sdkconfig
93+
$ idf.py -D 'SDKCONFIG_DEFAULTS=sdkconfig_m5stack.defaults' build
94+
95+
Note: If using a specific device configuration, it is highly recommended to
96+
start off with one of the defaults and customize on top of that. Certain
97+
configurations have different constraints that are customized within the
98+
device specific configuration (eg: main app stack size).
99+
100+
To customize the configuration, run menuconfig.
88101

89102
$ idf.py menuconfig
90103

0 commit comments

Comments
 (0)