Skip to content

docs: fix stale binding-generation instructions (ffigen -> flutter_rust_bridge) #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sneurlax wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix stale binding-generation instructions (ffigen -> flutter_rust_bridge) #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ cargo install cargo-ndk

### Cargokit

[Cargokit](https://github.com/irondash/cargokit) handles building, just `flutter run` it or run it in Android Studio or VS Code (untested).
[Cargokit](https://github.com/irondash/cargokit) builds and bundles the native Rust library (in `rust/`) for each platform, just `flutter run` it or run it in Android Studio or VS Code (untested).

To update Cargokit in the future, use:
```sh
Expand All @@ -32,7 +32,17 @@ git subtree pull --prefix cargokit https://github.com/irondash/cargokit.git main

## Development

To (re)generate Dart bindings run `just generate`
The Dart bindings in `lib/src/rust` are generated from the Rust API in `rust/` by [flutter_rust_bridge](https://github.com/fzyzcjy/flutter_rust_bridge).

Install the codegen tool once, matching the `flutter_rust_bridge` version in `pubspec.yaml`:
```sh
cargo install flutter_rust_bridge_codegen --version 2.11.1
```

Then, after changing the Rust API, regenerate the bindings with:
```sh
flutter_rust_bridge_codegen generate
```

## Example app

Expand Down
Loading