Skip to content

chore: README update #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 28, 2025
Merged

chore: README update #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae15fa5
chore: README update
topher200 Mar 28, 2025
edbd31e
Update README.md
noahp Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ here relative to the ESP-IDF SDK root folder:

- `examples/system/console/advanced/`

```bash
$ git submodule update --init --recursive
$ echo 'CONFIG_MEMFAULT_PROJECT_KEY="YOUR_KEY"' >> sdkconfig.defaults
# by default, 'idf.py build' will target esp32
$ idf.py build
# flash the board and start the serial monitor
$ idf.py flash monitor
```

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.
Expand Down