From 5785492d6ee265b81c415e3b7ba226f064cfed68 Mon Sep 17 00:00:00 2001 From: Daniel Nicoara Date: Mon, 7 Feb 2022 23:21:36 -0500 Subject: [PATCH] Update all_clusters_app README (#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. --- examples/all-clusters-app/esp32/README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md index 3f051fd1400d4e..8c912676dbc201 100644 --- a/examples/all-clusters-app/esp32/README.md +++ b/examples/all-clusters-app/esp32/README.md @@ -84,7 +84,20 @@ To set IDF target, run set-target with one of the commands. - Configuration Options -To choose from the different configuration options, run menuconfig. +To build the default configuration (`sdkconfig.defaults`) skip to building the +demo application. + +To build a specific configuration (as an example `m5stack`): + + $ rm sdkconfig + $ idf.py -D 'SDKCONFIG_DEFAULTS=sdkconfig_m5stack.defaults' build + + Note: If using a specific device configuration, it is highly recommended to + start off with one of the defaults and customize on top of that. Certain + configurations have different constraints that are customized within the + device specific configuration (eg: main app stack size). + +To customize the configuration, run menuconfig. $ idf.py menuconfig