diff --git a/README.md b/README.md index 10027f474b..903560c080 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,21 @@ * [中文版](./README_CN.md) -ESP-IDF is the development framework for Espressif SoCs (released after 2016[1](#fn1)) provided for Windows, Linux and macOS. +ESP-IDF is the development framework for Espressif SoCs supported on Windows, Linux and macOS. + +# ESP-IDF Release and SoC Compatibility + +The following table shows ESP-IDF support of Espressif SoCs where :yellow_circle: and :green_circle: denote preview status and support, respectively. In preview status the build is not yet enabled and some crucial parts could be missing (like documentation, datasheet). Please use an ESP-IDF release where the desired SoC is already supported. + +|Chip | v3.3 | v4.0 | v4.1 | v4.2 | v4.3 | v4.4 | | +|:----------- |:-------------: | :-------------:| :-------------:| :-------------:| :-------------:| :-------------:|:---------------------------------------------------------- | +|ESP32 | :green_circle: | :green_circle: | :green_circle: | :green_circle: | :green_circle: | :green_circle: | | +|ESP32-S2 | | | | :green_circle: | :green_circle: | :green_circle: | | +|ESP32-C3 | | | | | :green_circle: | :green_circle: | | +|ESP32-S3 | | | | | :yellow_circle:| :green_circle: | [Announcement](https://www.espressif.com/en/news/ESP32_S3) | +|ESP32-H2 | | | | | | :yellow_circle:| [Announcement](https://www.espressif.com/en/news/ESP32_H2) | + +Espressif SoCs released before 2016 (ESP8266 and ESP8285) are supported by [RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK) instead. # Developing With ESP-IDF @@ -99,8 +113,3 @@ This can be combined with other targets, ie `idf.py -p PORT erase_flash flash` w * [Check the Issues section on github](https://github.com/espressif/esp-idf/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one. * If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](https://docs.espressif.com/projects/esp-idf/en/latest/contribute/index.html). - - -________ - -1: ESP8266 and ESP8285 are not supported in ESP-IDF. See [RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK) instead. \ No newline at end of file diff --git a/README_CN.md b/README_CN.md index 5408040576..97b26ec620 100644 --- a/README_CN.md +++ b/README_CN.md @@ -2,7 +2,21 @@ * [English Version](./README.md) -ESP-IDF 是乐鑫官方推出的开发框架，适用于 2016 年之后发布的系列芯片[1](#fn1)，支持 Windows、Linux 和 macOS 操作系统。 +ESP-IDF 是乐鑫官方推出的物联网开发框架，支持 Windows、Linux 和 macOS 操作系统。 + +# ESP-IDF 与乐鑫芯片 + +下表总结了乐鑫芯片在 ESP-IDF 各版本中的支持状态，其中 :green_circle: 代表已支持，:yellow_circle: 代表目前处于预览支持状态。在预览支持阶段，因为新芯片尚未完全添加到构建系统目录，所以一些重要的内容（如文档和技术规格书等）可能会缺失。请确保使用与芯片相匹配的 ESP-IDF 版本。 + +| 芯片 | v3.3 | v4.0 | v4.1 | v4.2 | v4.3 | v4.4 | | +|:----------- |:-------------: | :-------------:| :-------------:| :-------------:| :-------------:| :-------------:|:---------------------------------------------------------- | +|ESP32 | :green_circle: | :green_circle: | :green_circle: | :green_circle: | :green_circle: | :green_circle: | | +|ESP32-S2 | | | | :green_circle: | :green_circle: | :green_circle: | | +|ESP32-C3 | | | | | :green_circle: | :green_circle: | | +|ESP32-S3 | | | | | :yellow_circle:| :green_circle: | [芯片发布公告](https://www.espressif.com/zh-hans/news/ESP32_S3) | +|ESP32-H2 | | | | | | :yellow_circle:| [芯片发布公告](https://www.espressif.com/zh-hans/news/ESP32_H2) | + +对于 2016 年之前发布的乐鑫芯片（包括 ESP8266 和 ESP8285），请参考 [RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK)。 # 使用 ESP-IDF 进行开发 @@ -99,8 +113,3 @@ ESP-IDF 中的子模块采用相对路径（[详见 .gitmodules 文件](.gitmodu * 如果你在使用中发现了错误或者需要新的功能，请先[查看 GitHub Issues](https://github.com/espressif/esp-idf/issues)，确保该问题没有重复提交。 * 如果你有兴趣为 ESP-IDF 作贡献，请先阅读[贡献指南](https://docs.espressif.com/projects/esp-idf/en/latest/contribute/index.html)。 - - -__________ - -1: ESP-IDF 不支持 ESP8266 和 ESP8285。如有需要，请参考 [RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK)。