From 7eac2d01f7b1f8086734d1f0df7c36ce3ac1f1da Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Tue, 29 Jul 2025 10:40:14 +0000 Subject: [PATCH] Update README.md --- README.en.md | 35 +++++++++++++++++++++++++++++++++++ README.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..92c02b4 --- /dev/null +++ b/README.en.md @@ -0,0 +1,35 @@ + + +# ESP32-S3 LED Project + +## Introduction +This project is an example program written for the ESP32-S3 microcontroller, primarily aimed at controlling LED behavior. It utilizes several embedded development libraries from the Rust language ecosystem, such as `esp-hal` and `esp-wifi`. The project includes a build script to handle linker arguments and provide friendly提示 information. + +## Key Features +- Control LEDs on the ESP32-S3. +- Uses Rust's `#![no_std]` and `#![no_main]` attributes, suitable for embedded development. +- Includes a build script that provides friendly linker提示 information. +- Depends on a series of embedded Rust libraries, such as `esp-println`, `esp-alloc`, `esp-wifi` for ESP32-S3 specific functionalities. + +## Installation +To run this project, you need to install the Rust toolchain and specific dependencies required for ESP32-S3 development. Ensure that you have set up the Rust development environment and install the toolchain required for ESP32-S3 using the following command: + +```bash +rustup target add riscv32imc-unknown-none-elf +``` + +Additionally, you need to install [ESP-IDF](https://github.com/espressif/esp-idf) to support ESP32-S3 development. + +## Usage +To build and run the project, use the following commands: + +```bash +cargo build --bin esp32s3_led +cargo run --bin esp32s3_led +``` + +## Contribution +Code contributions or suggestions for this project are welcome. Please fork this repository, make your modifications, and then submit a pull request. + +## License +This project is licensed under the MIT License. For more details, please refer to the license declaration in `Cargo.toml` or the relevant project files. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..56b7c6a --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ + + +# ESP32-S3 LED 项目 + +## 介绍 +这个项目是为 ESP32-S3 微控制器编写的一个示例程序,主要功能是控制 LED 的行为。它利用了 Rust 语言及其生态系统中的一些嵌入式开发库,例如 `esp-hal` 和 `esp-wifi`。项目中包含了一个构建脚本,用来处理链接器参数,并提供了一些友好的提示信息。 + +## 主要特性 +- 控制 ESP32-S3 上的 LED。 +- 使用 Rust 的 `#![no_std]` 和 `#![no_main]` 属性,适用于嵌入式开发。 +- 包含构建脚本,提供友好的链接器提示信息。 +- 依赖于一系列嵌入式 Rust 库,如 `esp-println`, `esp-alloc`, `esp-wifi` � for ESP32-S3 特定的功能。 + +## 安装 +要运行此项目,您需要安装 Rust 工具链和 ESP32-S3 开发所需的特定依赖。确保您已设置 Rust 开发环境,并通过以下命令安装 ESP32-S3 所需的工具链: + +```bash +rustup target add riscv32imc-unknown-none-elf +``` + +另外,您需要安装 [ESP-IDF](https://github.com/espressif/esp-idf) 以支持 ESP32-S3 开发。 + +## 使用 +要构建并运行项目,请使用以下命令: + +```bash +cargo build --bin esp32s3_led +cargo run --bin esp32s3_led +``` + +## 贡献 +欢迎为这个项目贡献代码或提出建议。请 fork 本仓库,进行修改,然后提交 pull 请求。 + +## 许可证 +本项目采用 MIT 许可证。有关更多详细信息,请参阅 `Cargo.toml` 中的许可证声明或项目的相关文件。 \ No newline at end of file -- Gitee