From e25b17b108c58cc9335bdf08d5c24f096add9ae6 Mon Sep 17 00:00:00 2001
From: gojimmypi <13059545+gojimmypi@users.noreply.github.com>
Date: Mon, 30 Aug 2021 17:35:17 -0700
Subject: [PATCH] Syntax / keyword highlighting / clarifications

See https://github.com/espressif/esp-wolfssl/issues/11
---
 IDE/Espressif/ESP-IDF/README.md | 31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

diff --git a/IDE/Espressif/ESP-IDF/README.md b/IDE/Espressif/ESP-IDF/README.md
index 24b06ddb5..54d4d4168 100644
--- a/IDE/Espressif/ESP-IDF/README.md
+++ b/IDE/Espressif/ESP-IDF/README.md
@@ -4,28 +4,33 @@
 
 Including the following examples:
 
-* simple tls_client/server
-* crypt test
-* crypt benchmark
+* Simple [tls_client](./examples/wolfssl_client/)/[server](./examples/wolfssl_server/)
+* Cryptographic [test](./examples/wolfssl_test/)
+* Cryptographic [benchmark](./examples/wolfssl_benchmark/)
 
  The *user_settings.h* file enables some of the hardened settings.
 
 ## Requirements
- 1. ESP-IDF development framework  
-    [https://docs.espressif.com/projects/esp-idf/en/latest/get-started/]
+ 1. [ESP-IDF development framework](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/)
 
     Note: This expects to use Linux version.
 
 ## Setup for Linux
- 1. Run *setup.sh* at /path/to/wolfssl/IDE/Espressif/ESP-IDF/ to deploy files into ESP-IDF tree  
-    For Windows : Run *setup_win.bat* at \IDE\Espressif\ESP-IDF\
- 2. Find Wolfssl files at /path/to/esp-idf/components/wolfssl/
- 3. Find Example programs under /path/to/esp-idf/examples/protocols/wolfssl_xxx
- 4. Uncomment out #define WOLFSSL_ESPIDF in /path/to/wolfssl/wolfssl/wolfcrypt/settings.h  
-    Uncomment out #define WOLFSSL_ESPWROOM32 in /path/to/wolfssl/wolfssl/wolfcrypt/settings.h
+ 1. Run `setup.sh` at _/path/to_`/wolfssl/IDE/Espressif/ESP-IDF/` to deploy files into ESP-IDF tree  
+    For Windows : Run `setup_win.bat` at `.\IDE\Espressif\ESP-IDF\`
+    
+ 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)
+
+ 4. Uncomment out `#define WOLFSSL_ESPIDF` in _/path/to/esp_`/esp-idf/components/wolfssl/wolfssl/wolfcrypt/settings.h`  
+    Uncomment out `#define WOLFSSL_ESPWROOM32` in _/path/to/esp_`/esp-idf/components/wolfssl/wolfssl/wolfcrypt/settings.h`
+    
+    for example the default:
+    `~/esp/esp-idf/components/wolfssl/wolfssl/wolfcrypt/settings.h`
 
 ## Configuration
- 1. The *user_settings.h* can be found in /path/to/esp-idf/components/wolfssl/include/user_settings.h
+ 1. The `user_settings.h` can be found in _/path/to/esp_`/esp-idf/components/wolfssl/include/user_settings.h`
 
 ## Build examples
  1. See README in each example folder
@@ -34,7 +39,7 @@ Including the following examples:
  For question please email [support@wolfssl.com]
 
  Note: This is tested with :  
-   - OS: Ubuntu 18.04.1 LTS and Microsoft Windows 10 Pro 10.0.19041  
+   - OS: Ubuntu 18.04.1 LTS and Microsoft Windows 10 Pro 10.0.19041 and well as WSL Ubuntu
    - ESP-IDF: v4.1 and v4.0.1  
    - Module : ESP32-WROOM-32