From ae15fa5468fcfaff7e6c2cab40875c712fdbbf95 Mon Sep 17 00:00:00 2001 From: Topher Brown Date: Thu, 27 Mar 2025 23:02:03 -0400 Subject: [PATCH 1/2] chore: README update It wasn't obvious to me that I needed to install submodules; adding a quick note on the commands required to get started with this example. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index c6884eb..b9fb8a2 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ here relative to the ESP-IDF SDK root folder: - `examples/system/console/advanced/` +``` +$ git submodule update --init --recursive +$ echo '\nCONFIG_MEMFAULT_PROJECT_KEY="YOUR_KEY"' >> sdkconfig.defaults +$ idf.py set-target esp32 +$ idf.py build +$ idf.py flash +``` + +Get your project key from https://mflt.io/project-key. + ## Configuring for MQTT This application includes an option to send Memfault data over MQTT. This option requires a few extra pieces to set up. From edbd31e8a0bb929cb9efb4d249b2f0f146ce8e76 Mon Sep 17 00:00:00 2001 From: Noah Pendleton <2538614+noahp@users.noreply.github.com> Date: Fri, 28 Mar 2025 09:49:46 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b9fb8a2..54a1b23 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,13 @@ here relative to the ESP-IDF SDK root folder: - `examples/system/console/advanced/` -``` +```bash $ git submodule update --init --recursive -$ echo '\nCONFIG_MEMFAULT_PROJECT_KEY="YOUR_KEY"' >> sdkconfig.defaults -$ idf.py set-target esp32 +$ echo 'CONFIG_MEMFAULT_PROJECT_KEY="YOUR_KEY"' >> sdkconfig.defaults +# by default, 'idf.py build' will target esp32 $ idf.py build -$ idf.py flash +# flash the board and start the serial monitor +$ idf.py flash monitor ``` Get your project key from https://mflt.io/project-key.