WolfSSL
/
wolfssh
mirror of https://github.com/wolfSSL/wolfssh.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update Espressif README with getting started info.

pull/771/head
gojimmypi 2025-06-12 11:36:35 -07:00
parent 6196e925d6
commit 89013e73cf
No known key found for this signature in database
GPG Key ID: 3D684FA88DC3FAA8
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ide/Espressif/README.md
View File

@ -1,8 +1,13 @@
# wolfSSH Espressif Component Install # 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 # ESP-IDF port
## Overview ## Overview
ESP-IDF development framework with wolfSSL by setting *WOLFSSL_ESPIDF* definition ESP-IDF development framework with wolfSSL by setting *WOLFSSL_ESPIDF* definition
Including the following examples: Including the following examples:
@ -18,7 +23,7 @@ Including the following examples:
## Setup for Linux ## 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/` 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) 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 cd ESP-IDF
setup_win.bat setup_win.bat
``` ```
3. Find Wolfssl files at _/path/to/esp_`/esp-idf/components/wolfssl/` 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 ## Support
For question please email [support@wolfssl.com] 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 - 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 - ESP-IDF: ESP-IDF v4.3.2
- Module : ESP32-WROOM-32 - Module : ESP32-WROOM-32