Skip to content

Commit 0e5d1fc

Browse files
authored
Merge pull request #771 from gojimmypi/pr-post-release-bbba8aef-espressif-readme
Update Espressif README with Getting Started info.
2 parents 6196e92 + 89013e7 commit 0e5d1fc

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

ide/Espressif/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# wolfSSH Espressif Component Install
22

3+
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).
4+
5+
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/).
36

47
# ESP-IDF port
8+
59
## Overview
10+
611
ESP-IDF development framework with wolfSSL by setting *WOLFSSL_ESPIDF* definition
712

813
Including the following examples:
@@ -18,7 +23,7 @@ Including the following examples:
1823

1924

2025
## Setup for Linux
21-
1. Run `setup.sh` at _/path/to_`/wolfssl/IDE/Espressif/ESP-IDF/` to deploy files into ESP-IDF tree
26+
1. Run `setup.sh` at _/path/to_`/wolfssl/IDE/Espressif/ESP-IDF/` to deploy files into ESP-IDF tree
2227
2. Find Wolfssl files at _/path/to/esp_`/esp-idf/components/wolfssl/`
2328
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)
2429

@@ -28,7 +33,7 @@ Including the following examples:
2833

2934
```
3035
cd ESP-IDF
31-
setup_win.bat
36+
setup_win.bat
3237
```
3338

3439
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
6570
## Support
6671
For question please email [[email protected]]
6772

68-
Note: This is tested with :
73+
Note: This is tested with :
6974
- OS: Ubuntu 20.04.3 LTS and Microsoft Windows 10 Pro 10.0.19041 and well as WSL Ubuntu
7075
- ESP-IDF: ESP-IDF v4.3.2
7176
- Module : ESP32-WROOM-32

0 commit comments

Comments
 (0)