readme: add build status badge && suggest using idf5.0

This commit is contained in:
Li Bo
2025-03-18 11:28:30 +08:00
parent 0f940d007a
commit cbe4e806ee
7 changed files with 13 additions and 9 deletions
+1 -1
View File
@@ -17,6 +17,6 @@ jobs:
shell: bash
run: |
. ${IDF_PATH}/export.sh
pip install idf-component-manager idf-build-apps --upgrade
pip install idf-component-manager idf-build-apps
idf-build-apps find
idf-build-apps build
+3 -1
View File
@@ -3,11 +3,13 @@
* [中文](./README_cn.md)
[![Build project](https://github.com/espressif/esp-drone/actions/workflows/build_project.yml/badge.svg)](https://github.com/espressif/esp-drone/actions/workflows/build_project.yml)
### Introduction
**ESP-Drone** is an open source solution based on Espressif ESP32/ESP32-S2/ESP32-S3 Wi-Fi chip, which can be controlled by a mobile APP or gamepad over **Wi-Fi** connection. ESP-Drone comes with **simple hardware**, **clear and extensible code architecture**, and therefore this project can be used in **STEAM education** and other fields. The main code is ported from **Crazyflie** open source project with **GPL3.0** protocol.
> Currently support ESP32、ESP32S2、ESP32S3, please using ESP-IDF [release/v4.4](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html) branch as your develop environment
> Currently support ESP32、ESP32S2、ESP32S3, please using ESP-IDF [release/v5.0](https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html) branch as your develop environment
![ESP-Drone](./docs/_static/espdrone_s2_v1_2_2.png)
+3 -1
View File
@@ -3,11 +3,13 @@
* [English Version](./README.md)
[![Build project](https://github.com/espressif/esp-drone/actions/workflows/build_project.yml/badge.svg)](https://github.com/espressif/esp-drone/actions/workflows/build_project.yml)
### 简介
ESP-Drone 是基于乐鑫 ESP32/ESP32-S2/ESP32-S3 开发的小型无人机解决方案,可使用手机 APP 或游戏手柄通过 Wi-Fi 网络进行连接和控制。目前已支持自稳定飞行、定高飞行、定点飞行等多种模式。该方案硬件结构简单,代码架构清晰完善,方便功能扩展,可用于 STEAM 教育等领域。控制系统代码来自 Crazyflie 开源工程,使用 GPL3.0 开源协议。
> 目前已支持 ESP32、ESP32S2、ESP32S3, 请使用 ESP-IDF [release/v4.4](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html) 分支
> 目前已支持 ESP32、ESP32S2、ESP32S3, 请使用 ESP-IDF [release/v5.0](https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html) 分支
![ESP-Drone](./docs/_static/espdrone_s2_v1_2_2.png)
+2 -2
View File
@@ -5,11 +5,11 @@ Set up Development Environment
Set up ESP-IDF Environment
---------------------------------
Please refer to `ESP-IDF Programming Guide <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html>`__\ and set up ESP-IDF environmnet step by step.
Please refer to `ESP-IDF Programming Guide <https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html>`__\ and set up ESP-IDF environmnet step by step.
.. note::
- ESP-IDF branch ``release /v4.4`` is suggested.
- ESP-IDF branch ``release/v5.0`` is suggested.
- Please follow and complete all setup steps.
- Build a example of ESP-IDF to make sure the setup is successful.
+1 -1
View File
@@ -87,7 +87,7 @@ ESP-IDF is the IoT Development Framework provided by Espressif for ESP32/ESP32-S
For more information, please check `ESP-IDF
Programming Guide <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html>`__.
Programming Guide <https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html>`__.
Crazyflie Overview
=======================
+2 -2
View File
@@ -5,11 +5,11 @@
ESP-IDF 环境搭建
----------------
请参照 `ESP-IDF 编程指南 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html>`__\ ,按照步骤设置 ESP-IDF。
请参照 `ESP-IDF 编程指南 <https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html>`__\ ,按照步骤设置 ESP-IDF。
注意事项:
- 推荐安装 ESP-IDF `release/v4.4` 分支;
- 推荐安装 ESP-IDF `release/v5.0` 分支;
- 请完成 ESP-IDF 所有安装步骤;
- 建议首先编译一个 ESP-IDF 示例程序,用以检查安装的完整性。
+1 -1
View File
@@ -60,7 +60,7 @@ ESP-IDF 是乐鑫为 ESP32/ESP32-S2/ESP32-S3 提供的物联网开发框架。
- ESP-IDF 包含一系列库及头文件,提供了基于 ESP32/ESP32-S2/ESP32-S3 构建软件项目所需的核心组件。
- ESP-IDF 还提供了开发和量产过程中最常用的工具及功能,例如:构建、烧录、调试和测量等。
详情可查阅:`ESP-IDF 编程指南 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html>`__
详情可查阅:`ESP-IDF 编程指南 <https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html>`__
Crazyflie 简介
================