Skip to content

Commit 1ce0e17

Browse files
committed
Merge branch 'feat/update_br_docs' into 'main'
feat(docs): update br docs See merge request espressif/esp-thread-br!148
2 parents 17946c1 + c66a129 commit 1ce0e17

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ ESP-THREAD-BR is the official [ESP Thread Border Router](https://openthread.io/g
88

99
The SDK is built on top of [ESP-IDF](https://github.com/espressif/esp-idf) and [OpenThread](https://github.com/openthread/openthread). The OpenThread port and ESP Border Router implementation is provided as pre-built library in ESP-IDF.
1010

11-
It is recommended to use ESP-IDF [v5.3.1](https://github.com/espressif/esp-idf/tree/v5.3.1) with this SDK.
12-
1311
# Hardware Platforms
1412

1513
## Wi-Fi based Thread Border Router

docs/en/dev-guide/build_and_run.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,26 @@ This document contains instructions on building the images for ESP Thread Border
99

1010
Clone the `esp-idf <https://github.com/espressif/esp-idf>`_ and the `esp-thread-br <https://github.com/espressif/esp-thread-br>`_ repository.
1111

12-
It is recommended to use ESP-IDF `v5.3.1 <https://github.com/espressif/esp-idf/tree/v5.3.1>`_ with this SDK.
12+
The current esp-thread-br master branch is compatible with the ESP-IDF commit `e6aeb3d <https://github.com/espressif/esp-idf/commit/e6aeb3d36d2fcaf578e4e53308191a8e262dc822>`_.
13+
14+
Refer to the specific tags for each stable release at `esp-thread-br releases <https://github.com/espressif/esp-thread-br/releases>`_.
1315

1416
.. code-block:: bash
1517
16-
git clone -b v5.3.1 --recursive https://github.com/espressif/esp-idf.git
18+
git clone --recursive https://github.com/espressif/esp-idf.git
1719
1820
.. code-block:: bash
1921
2022
cd esp-idf
2123
24+
.. code-block:: bash
25+
26+
git checkout e6aeb3d36d2fcaf578e4e53308191a8e262dc822
27+
28+
.. code-block:: bash
29+
30+
git submodule update --init --depth 1
31+
2232
.. code-block:: bash
2333
2434
./install.sh

examples/basic_thread_border_router/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Please refer to [ESP Thread Border Router Hardware](../../README.md##Hardware-Pl
1414

1515
Refer to [ESP-IDF Get Started](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/get-started/index.html).
1616

17-
It is recommended to use ESP-IDF [v5.3.1](https://github.com/espressif/esp-idf/tree/v5.3.1) with this example.
17+
Currently, it is recommended to use ESP-IDF commit [e6aeb3d](https://github.com/espressif/esp-idf/commit/e6aeb3d36d2fcaf578e4e53308191a8e262dc822).
1818

1919
### Configure the project
2020

0 commit comments

Comments
 (0)