From 30d0a34d341730131065c24b7809070d7fa5d79e Mon Sep 17 00:00:00 2001 From: Aaron Kelly Date: Fri, 20 Jan 2017 21:17:00 +0000 Subject: [PATCH] esp32/README: Add comment about ESP-IDF version Just a comment about the changing state of the ESP-IDF version as it was a roadblock to development before Damien's addition to the Makefile about supported versions. --- esp32/README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/esp32/README.md b/esp32/README.md index 260614739..3032dff3e 100644 --- a/esp32/README.md +++ b/esp32/README.md @@ -29,7 +29,18 @@ ESP-IDF itself, which is found at https://github.com/espressif/esp-idf . Follow the guide "Setting Up ESP-IDF", for Windows, Mac or Linux. You only need to perform up to "Step 2" of the guide, by which stage you should have installed the cross-compile and cloned the ESP-IDF repository. - + +Be advised that the ESP-IDF is still undergoing changes and only some +versions are supported, to find which build is compatible refer to the line +in the makefile containing the following: +``` +ESPIDF_SUPHASH := +``` +After finishing "Step 2" you can roll back your current build of +the ESP-IDF using: +``` +$ git checkout +``` Once everything is set up you should have a functioning toolchain with prefix xtensa-esp32-elf- (or otherwise if you configured it differently) as well as a copy of the ESP-IDF repository.