From 89013e73cfe9b9100df677f8ee7c41fc38a5102b Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Thu, 12 Jun 2025 11:36:35 -0700 Subject: [PATCH] Update Espressif README with getting started info. --- ide/Espressif/README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/ide/Espressif/README.md b/ide/Espressif/README.md index 3250b191..0fc396b5 100644 --- a/ide/Espressif/README.md +++ b/ide/Espressif/README.md @@ -1,8 +1,13 @@ # wolfSSH Espressif Component Install +For more information on getting started with wolfSSL on the ESP32, see [wolfssl/IDE/Espressif/README.md](https://github.com/wolfSSL/wolfssl/blob/master/IDE/Espressif/README.md). + +See also [wolfSSH - Now Available as an Espressif Managed Component Includes SSH Echo Server Example](https://www.wolfssl.com/wolfssh-now-available-as-an-espressif-managed-component-includes-ssh-echo-server-example/). # ESP-IDF port + ## Overview + ESP-IDF development framework with wolfSSL by setting *WOLFSSL_ESPIDF* definition Including the following examples: @@ -18,7 +23,7 @@ Including the following examples: ## Setup for Linux - 1. Run `setup.sh` at _/path/to_`/wolfssl/IDE/Espressif/ESP-IDF/` to deploy files into ESP-IDF tree + 1. Run `setup.sh` at _/path/to_`/wolfssl/IDE/Espressif/ESP-IDF/` to deploy files into ESP-IDF tree 2. Find Wolfssl files at _/path/to/esp_`/esp-idf/components/wolfssl/` 3. Find [Example programs](https://github.com/wolfSSL/wolfssl/tree/master/IDE/Espressif/ESP-IDF/examples) under _/path/to/esp_`/esp-idf/examples/protocols/wolfssl_xxx` (where xxx is the project name) @@ -28,7 +33,7 @@ Including the following examples: ``` cd ESP-IDF -setup_win.bat +setup_win.bat ``` 3. Find Wolfssl files at _/path/to/esp_`/esp-idf/components/wolfssl/` @@ -65,7 +70,7 @@ setup_win.bat C:\SysGCC\esp32\esp-idf\v4.4 ## Support For question please email [support@wolfssl.com] - Note: This is tested with : + Note: This is tested with : - OS: Ubuntu 20.04.3 LTS and Microsoft Windows 10 Pro 10.0.19041 and well as WSL Ubuntu - ESP-IDF: ESP-IDF v4.3.2 - Module : ESP32-WROOM-32