Skip to content

Commit 19f05ff

Browse files
topher200noahp
andauthored
chore: README update (#5)
* 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. * Update README.md --------- Co-authored-by: Noah Pendleton <[email protected]>
1 parent 0aafaa5 commit 19f05ff

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@ here relative to the ESP-IDF SDK root folder:
55

66
- `examples/system/console/advanced/`
77

8+
```bash
9+
$ git submodule update --init --recursive
10+
$ echo 'CONFIG_MEMFAULT_PROJECT_KEY="YOUR_KEY"' >> sdkconfig.defaults
11+
# by default, 'idf.py build' will target esp32
12+
$ idf.py build
13+
# flash the board and start the serial monitor
14+
$ idf.py flash monitor
15+
```
16+
17+
Get your project key from https://mflt.io/project-key.
18+
819
## Configuring for MQTT
920

1021
This application includes an option to send Memfault data over MQTT. This option requires a few extra pieces to set up.

0 commit comments

Comments
 (0)