Skip to content

[ffigen] revamp readme #2691

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[ffigen] revamp readme #2691

wants to merge 2 commits into from
+275 −175

Conversation

goderbauer
Copy link
Contributor

This adds a simple "getting started" section to the readme to guide newcomers through setting up ffigen for a Dart app. It also fixes some minor issues in other parts of the readme.

Related to #2670, which did the same to the jnigen readme.

@github-actions GitHub Actions
Copy link

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?

This check can be disabled by tagging the PR with skip-breaking-check.

Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

This check can be disabled by tagging the PR with skip-changelog-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbol Leaking sources

This check can be disabled by tagging the PR with skip-leaking-check.

License Headers ✔️ 
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/objective_c/lib/src/ns_input_stream.dart

This check can be disabled by tagging the PR with skip-license-check.

dcharkes
dcharkes approved these changes Oct 10, 2025
View reviewed changes
Copy link
Collaborator

@dcharkes dcharkes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! 🚀

pkgs/ffigen/README.md Outdated
}
```

3. To generate the bindings, we will write a script using `ffigen` and place it
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ffigen -> package:ffigen or FFIgen ? (I believe ffigen and ffigen are wrong typesetting in our codebase.)

Copy link
Contributor Author

@goderbauer goderbauer Oct 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I standardized this to FFIgen, and did the same for JNIgen. At least in the readme. I'll do a pass over the rest of the code base in a separate change.

pkgs/ffigen/README.md
// ...
void answerToLife() {
print('The answer to the Ultimate Question is ${add(40, 2)}!');
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dcharkes dcharkes dcharkes approved these changes

Assignees

No one assigned

Labels

package:ffigen package:jnigen

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@goderbauer @dcharkes