Skip to content

Commit

Permalink
Merge branch 'feat/update_br_docs' into 'main'
Browse files Browse the repository at this point in the history
feat(docs): update br docs

See merge request espressif/esp-thread-br!148
  • Loading branch information
chshu committed Dec 5, 2024
2 parents 17946c1 + c66a129 commit 1ce0e17
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ ESP-THREAD-BR is the official [ESP Thread Border Router](https://openthread.io/g

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.

It is recommended to use ESP-IDF [v5.3.1](https://github.com/espressif/esp-idf/tree/v5.3.1) with this SDK.

# Hardware Platforms

## Wi-Fi based Thread Border Router
Expand Down
14 changes: 12 additions & 2 deletions docs/en/dev-guide/build_and_run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,26 @@ This document contains instructions on building the images for ESP Thread Border

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

It is recommended to use ESP-IDF `v5.3.1 <https://github.com/espressif/esp-idf/tree/v5.3.1>`_ with this SDK.
The current esp-thread-br master branch is compatible with the ESP-IDF commit `e6aeb3d <https://github.com/espressif/esp-idf/commit/e6aeb3d36d2fcaf578e4e53308191a8e262dc822>`_.

Refer to the specific tags for each stable release at `esp-thread-br releases <https://github.com/espressif/esp-thread-br/releases>`_.

.. code-block:: bash
git clone -b v5.3.1 --recursive https://github.com/espressif/esp-idf.git
git clone --recursive https://github.com/espressif/esp-idf.git
.. code-block:: bash
cd esp-idf
.. code-block:: bash
git checkout e6aeb3d36d2fcaf578e4e53308191a8e262dc822
.. code-block:: bash
git submodule update --init --depth 1
.. code-block:: bash
./install.sh
Expand Down
2 changes: 1 addition & 1 deletion examples/basic_thread_border_router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Please refer to [ESP Thread Border Router Hardware](../../README.md##Hardware-Pl

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

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

### Configure the project

Expand Down

0 comments on commit 1ce0e17

Please sign in to comment.