Skip to content

Commit cbe4e80

Browse files
committed
readme: add build status badge && suggest using idf5.0
1 parent 0f940d0 commit cbe4e80

File tree

7 files changed

+13
-9
lines changed

7 files changed

+13
-9
lines changed

.github/workflows/build_project.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ jobs:
1717
shell: bash
1818
run: |
1919
. ${IDF_PATH}/export.sh
20-
pip install idf-component-manager idf-build-apps --upgrade
20+
pip install idf-component-manager idf-build-apps
2121
idf-build-apps find
2222
idf-build-apps build

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33

44
* [中文](./README_cn.md)
55

6+
[![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)
7+
68
### Introduction
79

810
**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.
911

10-
> 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
12+
> 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
1113
1214
![ESP-Drone](./docs/_static/espdrone_s2_v1_2_2.png)
1315

README_cn.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33

44
* [English Version](./README.md)
55

6+
[![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)
7+
68
### 简介
79

810
ESP-Drone 是基于乐鑫 ESP32/ESP32-S2/ESP32-S3 开发的小型无人机解决方案,可使用手机 APP 或游戏手柄通过 Wi-Fi 网络进行连接和控制。目前已支持自稳定飞行、定高飞行、定点飞行等多种模式。该方案硬件结构简单,代码架构清晰完善,方便功能扩展,可用于 STEAM 教育等领域。控制系统代码来自 Crazyflie 开源工程,使用 GPL3.0 开源协议。
911

10-
> 目前已支持 ESP32、ESP32S2、ESP32S3, 请使用 ESP-IDF [release/v4.4](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html) 分支
12+
> 目前已支持 ESP32、ESP32S2、ESP32S3, 请使用 ESP-IDF [release/v5.0](https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html) 分支
1113
1214
![ESP-Drone](./docs/_static/espdrone_s2_v1_2_2.png)
1315

docs/en/rst/getespidf.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ Set up Development Environment
55
Set up ESP-IDF Environment
66
---------------------------------
77

8-
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.
8+
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.
99

1010
.. note::
1111

12-
- ESP-IDF branch ``release /v4.4`` is suggested.
12+
- ESP-IDF branch ``release/v5.0`` is suggested.
1313
- Please follow and complete all setup steps.
1414
- Build a example of ESP-IDF to make sure the setup is successful.
1515

docs/en/rst/gettingstarted.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ ESP-IDF is the IoT Development Framework provided by Espressif for ESP32/ESP32-S
8787

8888

8989
For more information, please check `ESP-IDF
90-
Programming Guide <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html>`__.
90+
Programming Guide <https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html>`__.
9191

9292
Crazyflie Overview
9393
=======================

docs/zh_CN/rst/getespidf.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
ESP-IDF 环境搭建
66
----------------
77

8-
请参照 `ESP-IDF 编程指南 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html>`__\ ,按照步骤设置 ESP-IDF。
8+
请参照 `ESP-IDF 编程指南 <https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html>`__\ ,按照步骤设置 ESP-IDF。
99

1010
注意事项:
1111

12-
- 推荐安装 ESP-IDF `release/v4.4` 分支;
12+
- 推荐安装 ESP-IDF `release/v5.0` 分支;
1313
- 请完成 ESP-IDF 所有安装步骤;
1414
- 建议首先编译一个 ESP-IDF 示例程序,用以检查安装的完整性。
1515

docs/zh_CN/rst/gettingstarted.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ ESP-IDF 是乐鑫为 ESP32/ESP32-S2/ESP32-S3 提供的物联网开发框架。
6060
- ESP-IDF 包含一系列库及头文件,提供了基于 ESP32/ESP32-S2/ESP32-S3 构建软件项目所需的核心组件。
6161
- ESP-IDF 还提供了开发和量产过程中最常用的工具及功能,例如:构建、烧录、调试和测量等。
6262

63-
详情可查阅:`ESP-IDF 编程指南 <https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s2/get-started/index.html>`__。
63+
详情可查阅:`ESP-IDF 编程指南 <https://docs.espressif.com/projects/esp-idf/en/release-v5.0/esp32s2/get-started/index.html>`__。
6464

6565
Crazyflie 简介
6666
================

0 commit comments

Comments
 (0)