monorepo/flipper-zero/README.md

1.5 KiB

flipperzero-template🚀

A template for kick-starting a Rust + FlipperZero project using flipperzero-rs 🐬❤️🦀.

Currently supports SDK 35.0 (flipperzero-firmware@0.89.0).

Usage

Initial setup

  1. Install rustup by following the instructions on rustup.rs.
  2. Install the nightly build tool-chain to support thedifferent-binary-name feature:
    rustup toolchain install nightly
    
  3. Install cargo-generate:
    cargo install cargo-generate
    
  4. Use rustup to install the thumbv7em-none-eabihf target to the nightly build:
    rustup target add --toolchain nightly thumbv7em-none-eabihf
    

Generate the project

  1. Use cargo generate to clone this template:
    cargo generate --git https://github.com/flipperzero-rs/flipperzero-template.git --name my-project
    
  2. Switch into the local directory:
    cd my-project
    

Build with cargo build

cargo build

Copy the binary to your Flipper Zero

The resulting .fap binary can be found in target/thumbv7em-none-eabihf/debug.

License

This template is licensed under the MIT License.