Skip to content

Commit

Permalink
Merge pull request #496 from gabsuren/readme_websocket_linux
Browse files Browse the repository at this point in the history
docs(websocket): Added README for websocket host example (IDF-9115)
  • Loading branch information
gabsuren authored Jan 26, 2024
2 parents f42c0ad + 2f7c582 commit 5ba7cfa
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions components/esp_websocket_client/examples/linux/README.md
Original file line number Diff line number Diff line change
@@ -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`):

0 comments on commit 5ba7cfa

Please sign in to comment.