From 44a420761c1476d83a1be1cc6ec40514e5cd3bbd Mon Sep 17 00:00:00 2001 From: TDA2030 <1932489836@qq.com> Date: Tue, 22 Mar 2022 12:05:08 +0800 Subject: [PATCH] docs: remove description about idf patch --- README.md | 8 ++++++-- README_cn.md | 6 +++++- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 22e7d732..382ac401 100644 --- a/README.md +++ b/README.md @@ -59,14 +59,18 @@ The ESP-BOX is a new generation AIoT development platform released by Espressif * For experiencing a more humanized interactive experience, please refer to the [Continuous Speech Recognition](./docs/getting_started.md#continuous-recognition). * For defining the speech commands by mobile APP, please refer to the [ESP-BOX APP User Guide](./docs/getting_started.md#voice-command-customization). * For product exploded-view and disassembly tutorial, please refer to [Disassembly Tutorial](docs/disassembly_tutorial.md). -* For more detils of hardware information, please refer to the [Hardware Overview](./docs/hardware_overview). +* For more details of hardware information, please refer to the [Hardware Overview](./docs/hardware_overview). * For latest version firmware, please refer to the [Firmware Update](./docs/firmware_update.md). ## Developer Guide +ESP-BOX integrates components commonly used in AIOT development that you can leverage to build your own applications. + +### Quick Start + * **Step 1**. ESP-IDF (Espressif IoT Development Framework) is required to build the application. If this is your first time using the ESP-IDF, please refer to [ESP-IDF development guide](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/index.html) to understand the open-source drivers and components provided by Espressif. * **Step 2**. Next, setting up development environment. Please refer to [ESP-IDF(release/v4.4) Installation Step by Step](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/get-started/index.html#installation-step-by-step). -* **Step 3**. Additionally, apply the patch files on current ESP-IDF, please refer [Patch for ESP-IDF](./idf_patch) for details. +* **Step 3**. Run command `git clone --recursive https://github.com/espressif/esp-box.git` to download the code of this project and then switch the ESP-IDF version to [specified version](#versions); * **Step 4**. Take a small step, you can [build and flash a simple example](./examples/image_display). * **Step 5**. Moving further, please read [ESP-BOX technical architecture](./docs/technical_architecture.md) to understand the technical details. * **Step 6**. Going deeper, please read [ESP Speech Recognition Application Guide](https://github.com/espressif/esp-sr), [ESP RainMaker Programming Guide](https://docs.espressif.com/projects/esp-rainmaker/en/latest/), [LVGL GUI Quick overview](https://docs.lvgl.io/8.1/get-started/index.html). diff --git a/README_cn.md b/README_cn.md index 1c5d3b88..b139edb7 100644 --- a/README_cn.md +++ b/README_cn.md @@ -64,9 +64,13 @@ ESP-BOX 是乐鑫信息科技发布的新一代 AIoT 应用开发平台。ESP32- ## 开发指引 +esp-box 集成了 AIOT 开发中常用的组件，您可以利用这些组件构建自己的应用。 + +### 快速开始 + * **Step 1**. 如果您首次接触 ESP-IDF 开发，建议先浏览 [ESP-IDF 编程指南](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/index.html)，了解乐鑫已经提供的开源驱动和组件； * **Step 2**. 接下来您可以详细阅读 [ESP-IDF（release/v4.4） 环境搭建指引](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/get-started/index.html#installation-step-by-step)，一步一步完成开发环境搭建； -* **Step 3**. 此外，请在当前 ESP-IDF 上打上补丁，详情请参考 [Patch for ESP-IDF](./idf_patch)； +* **Step 3**. 使用指令 `git clone --recursive https://github.com/espressif/esp-box.git` 下载本项目的代码，然后需要将 esp-idf 版本切换到[指定的版本](#版本信息)； * **Step 4**. 小试牛刀，您可以尝试 [构建并烧录一个新的示例程序](./examples/image_display)； * **Step 5**. 更进一步，您可以阅读 [ESP-BOX 技术架构说明](./docs/technical_architecture_cn.md)，了解更多技术细节； * **Step 6**. 深入开发，您可以阅读 [ESP 语音识别应用开发指南](https://github.com/espressif/esp-sr)，[ESP RainMaker 编程指南](https://docs.espressif.com/projects/esp-rainmaker/en/latest/)，[LVGL UI 界面开发快速总览](https://docs.lvgl.io/8.1/get-started/index.html)；