diff --git a/components/esp_websocket_client/examples/linux/README.md b/components/esp_websocket_client/examples/linux/README.md new file mode 100644 index 0000000000..08c322725b --- /dev/null +++ b/components/esp_websocket_client/examples/linux/README.md @@ -0,0 +1,9 @@ +# ESP Websocket Client - Host Example + +This example demonstrates the ESP websocket client using the `linux` target. It allows for compilation and execution of the example directly within a Linux environment. + +## Compilation and Execution +To compile and execute this example on Linux, follow the standard procedures for building and running ESP-IDF projects under the Linux platform. + +## Coverage Reporting +For generating a coverage report, it's necessary to enable `CONFIG_GCOV_ENABLED=y` option. Set the following configuration in your project's SDK configuration file (`sdkconfig.ci.coverage`, `sdkconfig.ci.linux` or via `menuconfig`):