Skip to content

Commit

Permalink
Correct build instructions and dependencies
Browse files Browse the repository at this point in the history
The code will only build with ESP-IDF v5.1.x (or newer). It has not been tested with ESP-IDF v5.2 or master at this time.

Fixes #11
  • Loading branch information
atanisoft committed Dec 23, 2023
1 parent f273c4f commit 1ea8b9e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions firmware/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,20 @@ Pressing the User button will generate a pair of events.

## Building

The ESP32 OpenLCB IO Board depends on ESP-IDF v4.4.x and will not build with
ESP-IDF v5.0.x at this time.
The ESP32 OpenLCB IO Board depends on ESP-IDF v5.1.x and will not build with
earlier versions.

### Configuring ESP-IDF build environment

For Windows environments please use the [Windows Installer](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html)
and select `release/v4.4` when prompted for a version. It is only necessary to
and select `release/v5.1` when prompted for a version. It is only necessary to
install the basic command line tools, Eclipse (or other IDEs) are optional.

For Linux / Mac environments it is recommended to use `git clone` to setup and
maintain the ESP-IDF build enviornment:
```
git clone https://github.com/espressif/esp-idf.git --depth 1 --branch release/v4.4 esp-idf-v4.4 --recursive
cd esp-idf-v4.4
git clone https://github.com/espressif/esp-idf.git --depth 1 --branch release/v5.1 esp-idf-v5.1 --recursive
cd esp-idf-v5.1
sh install.sh
```

Expand Down
2 changes: 1 addition & 1 deletion firmware/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
dependencies:
idf: ">=5.0"
idf: ">=5.1"
OpenMRNIDF:
version: 5.1.0
git: https://github.com/atanisoft/OpenMRNIDF.git
Expand Down

0 comments on commit 1ea8b9e

Please sign in to comment.