Skip to content

Commit

Permalink
Update components/console_simple_init/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Ivan Grokhotkov <[email protected]>
  • Loading branch information
espressif-abhikroy and igrr authored Oct 25, 2023
1 parent 5f8011d commit 6dd55e9
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion components/console_simple_init/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ It also provides an api to register an user provided command.
```

### Automatic registration of console commands
To add a plugin command or any component from IDF component manager into your project, simply include an entry within the `idf_component.yml` file.
`console_simple_init` component provides a function `console_cmd_all_register` which performs automatic registration of all commands linked into the application.

In order for the command to be registered automatically, it has to place the registration function into console_simple_init_desc section.

<Here, either add a code snippet showing how to do this, or link to a piece of code in this repository>

For more details refer [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html)

0 comments on commit 6dd55e9

Please sign in to comment.