Skip to content

Commit 0adf81e

Browse files
authored
Add a warning about binaries to library README (#250)
Call out the requirement that the library and the Flutter application must be build with the same version, since some people have started distributing binary versions apparently without being aware of this.
1 parent 5881f2b commit 0adf81e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

library/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ for now there is no equivalent to `flutter create`.
1717
There are currently no binary releases of the libraries. While a more
1818
Flutter-like model of using an SDK containing pre-compiled binaries is likely
1919
to be supported in the future, for now you must build the library from source.
20+
(**Note:** You may be tempted to pre-build a generic binary that can run any
21+
Flutter app. If you do, keep in mind that the primary reason there are no
22+
binary releases is that you *must* use the same version of Flutter to build
23+
`flutter_assets` as you use to build the library. If you later upgrade Flutter,
24+
or if you distribute the binary version to other people building their
25+
applications with different versions of Flutter, it will break.)
2026

2127
Once you build the library for your platform, link it into your build using
2228
whatever build system you are using, and add the relevant headers (see

0 commit comments

Comments
 (0)