From 2eb0c4d27d949f5a8fc2a52f148601cf5243dd38 Mon Sep 17 00:00:00 2001 From: Shu Chen Date: Wed, 3 Jul 2024 00:11:27 +0800 Subject: [PATCH] Update README.md with active links (#23) --- README.md | 35 +++++------------------------------ 1 file changed, 5 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 620a29e..24bce92 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,7 @@ -[![Build][ot-esp32-gh-action-build-svg]][ot-esp32-gh-action-build] +This repository is no longer maintained. ---- +OpenThread is officially supported in [ESP-IDF](https://idf.espressif.com/). Please refer to the following links for using OpenThread on Espressif SoCs: -# OpenThread on ESP32 - -**ot-esp32** is a port of OpenThread for the [Espressif ESP32 platform](https://www.espressif.com/en/products/socs/esp32/overview), where OpenThread uses a [Radio Co-Processor (RCP) design](https://openthread.io/platforms#radio-co-processor-rcp), transmitting and receiving radio using an 802.15.4-capable SoC. - -For more information on OpenThread, see [openthread.io](https://openthread.io). - -[ot-esp32-gh-action-build]: https://github.com/openthread/ot-esp32/actions?query=workflow%3ABuild+branch%3Amaster+event%3Apush -[ot-esp32-gh-action-build-svg]: https://github.com/openthread/ot-esp32/workflows/Build/badge.svg?branch=master&event=push - -## Getting started - -Get started with the [example CLI application](example/README.md). - -## Contributing - -We would love for you to contribute to OpenThread ESP32 and help make it even better than it is today! See our [Contributing Guidelines](https://github.com/openthread/ot-esp32/blob/master/CONTRIBUTING.md) for more information. - -Contributors are required to abide by our [Code of Conduct](https://github.com/openthread/ot-esp32/blob/master/CODE_OF_CONDUCT.md) and [Coding Conventions and Style Guide](https://github.com/openthread/openthread/blob/master/STYLE_GUIDE.md). - -## Versioning - -OpenThread ESP32 follows the [Semantic Versioning guidelines](http://semver.org/) for release cycle transparency and to maintain backwards compatibility. - -## License - -OpenThread ESP32 is released under the [BSD 3-Clause license](https://github.com/openthread/ot-esp32/blob/master/LICENSE). See the [`LICENSE`](https://github.com/openthread/ot-esp32/blob/master/LICENSE) file for more information. - -Please only use the OpenThread ESP32 name and marks when accurately referencing this software distribution. Do not use the marks in a way that suggests you are endorsed by or otherwise affiliated with Nest, Google, or The Thread Group. +- [Codelab](https://openthread.io/codelabs/esp-openthread-hardware) +- [OpenThread examples in ESP-IDF](https://github.com/espressif/esp-idf/tree/master/examples/openthread) +- [Espressif Thread Border Router](https://docs.espressif.com/projects/esp-thread-br)