Skip to content

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

Open
sneurlax wants to merge 1 commit into
Foundation-Devices:mainfrom
sneurlax:fix/docs
Open

docs: fix stale binding-generation instructions (ffigen -> flutter_rust_bridge)#76
sneurlax wants to merge 1 commit into
Foundation-Devices:mainfrom
sneurlax:fix/docs

Conversation

@sneurlax

Copy link
Copy Markdown
Collaborator

The README tells developers to regenerate Dart bindings with just generate, which runs dart run ffigen, which is the pre-FRB binding generator that is no longer a dependency, so the recipe fails. The project now generates bindings with flutter_rust_bridge; document the actual flutter_rust_bridge_codegen generate workflow instead.

Keep the Cargokit docs: cargokit still builds and bundles the native Rust library on every platform. Clarify that cargokit builds the library while flutter_rust_bridge only generates the bindings, since the two are easily confused.

…st_bridge)

The README told developers to regenerate Dart bindings with `just generate`,
which runs `dart run ffigen`, which is the pre-FRB binding generator that is no longer
a dependency, so the recipe fails. The project now generates bindings with
flutter_rust_bridge; document the actual `flutter_rust_bridge_codegen generate`
workflow instead.

Keep the Cargokit docs: cargokit still builds and bundles the native Rust
library on every platform. Clarify that cargokit builds the library while
flutter_rust_bridge only generates the bindings, since the two are easily
confused.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant