xdanielpaul/cmp

readme

This component is an example, to be used with the IDF component manager.

To use it with your ESP-IDF project make sure that [the component manager](https://pypi.org/project/idf-component-manager/) is installed and create the manifest `idf_component.yml` in the project's `main` component directory:

```yaml
dependencies:
  example/cmp: "^3.3.3"
```

## API

This component defines only one function `void cmp_hello()` that prints a welcome message.

### Example

```C
#include "cmp.h"

void app_main(void)
{
    cmp_hello();
}
```

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.