从模板生成项目

我们目前维护了两个模板仓库:

这两个模板都是基于 cargo-generate,这是一个用于按照现成模板创建新项目的工具。这里的 esp-idf-templateesp-template 可用于生成应用程序,附带所有必需的配置和依赖项。

  1. 安装 cargo generate

    cargo install cargo-generate
    
  2. 基于以上模板之一生成项目:

    • esp-template
      cargo generate esp-rs/esp-template
      
      关于模板项目的更多信息,请参阅 esp-template 简介
    • esp-idf-template
      cargo generate esp-rs/esp-idf-template cargo
      
      关于模板项目的更多信息,请参阅 esp-idf-template 简介

    调用 cargo generate 子命令时,它会询问几个关于应用程序目标的问题。完成这些问题后,就会生成一个配置好的项目,可以直接构建。

  3. 构建/运行生成的项目:

    • cargo build 编译项目(自动使用合适的工具链和目标)。
    • cargo run 编译项目、向目标设备烧写程序、并开启一个串口监视器。

在模板中使用开发容器(Dev Container)

两个模板仓库都带有开发容器支持,详见模板 README 的 Dev Containers 章节。

开发容器使用 idf-rust 镜像,配置开发环境中的使用容器一节对此进行了解释。这个镜像提供了一个无需安装即可为乐鑫芯片开发 Rust 应用程序的环境。开发容器还可以与 Wokwi 模拟器协作,以模拟项目,并允许使用 web-flash 从容器中进行烧写。