flipperzero-template - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #go #android #rust #deep-learning #linux #nodejs #macos #awesome #kubernetes #security #openai

flipperzero-template

(★ 108)

A template for starting a flipperzero-rs project for the Flipper Zero🐬

파일 탐색기

최종 버전 다운로드 (.zip)

- config.toml
- main.rs
- rustacean-10x10.icon
- rustacean-10x10.png
.gitignore
cargo-generate.toml
Cargo.toml
README.md
rust-toolchain.toml

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/flipperzero-rs/flipperzero-template

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd flipperzero-template

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Rust (rustup) cargo 명령어를 쓰려면 Rust가 필요합니다.

cargo install cargo-generate

crates.io에 배포된 패키지를 빌드해서 설치합니다. 레포를 직접 클론할 필요가 없습니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Rust

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Rust (rustup) rustup으로 설치하면 cargo도 함께 설치됩니다.

cargo install cargo-generate

crates.io에 배포된 패키지를 빌드해서 설치합니다. 레포를 직접 클론할 필요가 없습니다.

cargo generate --git https://github.com/flipperzero-rs/flipperzero-template.git --name my-project

이 명령어를 터미널에 그대로 입력해 실행하세요.

cargo build

Rust 프로젝트를 컴파일합니다.

cargo watch -s 'cargo build --release && run-fap target/thumbv7em-none-eabihf/release/my-project.fap'

Rust 프로젝트를 컴파일합니다.

✅ cargo build가 에러 없이 끝나면 성공입니다. target/ 폴더에 실행 파일이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# `flipperzero-template`🚀

A template for kick-starting a Rust + FlipperZero project using [`flipperzero-rs`](https://github.com/flipperzero-rs/flipperzero) 🐬❤️🦀.

# Usage

## Initial setup

1. Install [`rustup`](https://rust-lang.github.io/rustup/) by following the instructions on [`rustup.rs`](https://rustup.rs/).
1. Install the nightly build tool-chain to support the[`different-binary-name`](https://doc.rust-lang.org/cargo/reference/unstable.html#different-binary-name) feature:
    ```
    rustup toolchain install nightly
    ```
1. Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate):
    ```
    cargo install cargo-generate
    ```
1. 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
    ```
1. Switch into the local directory:
    ```
    cd my-project
    ```

## Build with `cargo build`

```
cargo build
```

## Copy the binary to your Flipper Zero

> [!IMPORTANT]
> This requires the `storage` command from [`flipperzero-tools`](https://crates.io/crates/flipperzero-tools) (`cargo install --locked flipperzero-tools`) or [`storage.py`](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/scripts/storage.py) from the official SDK.

The resulting `.fap` binary can be found in [`target/thumbv7em-none-eabihf/debug`](target/thumbv7em-none-eabihf/debug).

```sh
storage send target/thumbv7em-none-eabihf/release/my-project.fap /ext/apps/Examples/my-project.fap
```

## Build and run on change

> [!IMPORTANT]
> This requires the `run-fap` command from [`flipperzero-tools`](https://crates.io/crates/flipperzero-tools) (`cargo install --locked flipperzero-tools`) or [`runfap.py`](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/scripts/runfap.py) from the official SDK.

You can automatically build and run your binary using [`cargo-watch`](https://crates.io/crates/cargo-watch) and the `run-fap` tool.

```sh
cargo watch -s 'cargo build --release && run-fap target/thumbv7em-none-eabihf/release/my-project.fap'
```

# License

This template is licensed under the [MIT License](https://github.com/flipperzero-rs/flipperzero/blob/v0.7.2/LICENSE).