Merge pull request #496 from gabsuren/readme_websocket_linux

docs(websocket): Added README for websocket host example (IDF-9115)
This commit is contained in:
Suren
2024-01-26 20:31:15 +04:00
committed by GitHub

View File

@ -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`):