diff --git a/README.md b/README.md index 6082d528d..7a5feef87 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ * [中文版](./README_CN.md) -ESP-IDF is the official development framework for the [ESP32 and ESP32-S Series SoCs](https://www.espressif.com/en/products/hardware/soc). +ESP-IDF is the official development framework for the **ESP32** and **ESP32-S** Series SoCs. # Developing With ESP-IDF @@ -10,8 +10,12 @@ ESP-IDF is the official development framework for the [ESP32 and ESP32-S Series See setup guides for detailed instructions to set up the ESP-IDF: -* [Getting Started Guide for the stable ESP-IDF version](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/) -* [Getting Started Guide for the latest (master branch) ESP-IDF version](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/) +| Chip | Getting Started Guides for ESP-IDF | +|:----:|:----| +| ESP32 | | +| ESP32-S2 | | + +**Note:** Each ESP-IDF release has its own documentation. Please see Section [Versions](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/versions.html) how to find documentation and how to checkout specific release of ESP-IDF. ### Non-GitHub forks diff --git a/README_CN.md b/README_CN.md index 92cfc189e..5069ebe63 100644 --- a/README_CN.md +++ b/README_CN.md @@ -2,7 +2,7 @@ * [English Version](./README.md) -ESP-IDF 是由乐鑫官方推出的针对 [ESP32 和 ESP32-S2](https://www.espressif.com/en/products/hardware/soc) 系列芯片的开发框架。 +ESP-IDF 是由乐鑫官方推出的针对 **ESP32** 和 **ESP32-S2** 系列芯片的开发框架。 # 使用 ESP-IDF 进行开发 @@ -10,8 +10,13 @@ ESP-IDF 是由乐鑫官方推出的针对 [ESP32 和 ESP32-S2](https://www.espre 请参阅如下指南搭建 ESP-IDF 的开发环境： -* [ESP-IDF 稳定版本的入门指南](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/) -* [ESP-IDF 开发版本（master 分支）的入门指南](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/) +| 芯片 | ESP-IDF 入门指南 | +|:----:|:----| +| ESP32 | | +| ESP32-S2 | | + +**注意：** 每个 ESP-IDF 版本都有其对应的文档。 请参阅 [版本](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/versions.html) 部分，如何查找文档以及如何检出ESP-IDF的特定发行版。 + ### 非 GitHub 分叉的 ESP-IDF 项目 diff --git a/docs/_static/chip-esp32-s2.svg b/docs/_static/chip-esp32-s2.svg new file mode 100644 index 000000000..9ff21a763 --- /dev/null +++ b/docs/_static/chip-esp32-s2.svg @@ -0,0 +1,540 @@ + + + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ESP32 + + + +S2 + + + + \ No newline at end of file diff --git a/docs/_static/chip-esp32.svg b/docs/_static/chip-esp32.svg new file mode 100644 index 000000000..53e3c5f81 --- /dev/null +++ b/docs/_static/chip-esp32.svg @@ -0,0 +1,473 @@ + + + +image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ESP32 + + + + \ No newline at end of file