Skip to content
This repository was archived by the owner on Sep 6, 2023. It is now read-only.

Commit 9ef392b

Browse files
albaEDAdpgeorge
authored andcommitted
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.
1 parent b8bec1d commit 9ef392b

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

esp32/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ Follow the guide "Setting Up ESP-IDF", for Windows, Mac or Linux. You
3030
only need to perform up to "Step 2" of the guide, by which stage you
3131
should have installed the cross-compile and cloned the ESP-IDF repository.
3232

33+
Be advised that the ESP-IDF is still undergoing changes and only some
34+
versions are supported. To find which build is compatible refer to the line
35+
in the makefile containing the following:
36+
```
37+
ESPIDF_SUPHASH := <Current supported ESP-IDF commit hash>
38+
```
39+
After finishing "Step 2" you can roll back your current build of
40+
the ESP-IDF using:
41+
```
42+
$ git checkout <Current supported ESP-IDF commit hash>
43+
```
44+
Note that you will get a warning when building the code if the ESP-IDF
45+
version is incorrect.
46+
3347
Once everything is set up you should have a functioning toolchain with
3448
prefix xtensa-esp32-elf- (or otherwise if you configured it differently)
3549
as well as a copy of the ESP-IDF repository.

0 commit comments

Comments
 (0)