Skip to content

Commit 0289b79

Browse files
authored
Update README.md
1 parent 421411c commit 0289b79

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,40 @@ Flutter Wayland
33

44
A Flutter Embedder that talks to Wayland.
55

6-
Setup Instructions
7-
------------------
6+
Build Setup Instructions
7+
------------------------
88

99
* Install the following packages (on Debian Stretch): `weston`, `libwayland-dev`, `cmake` and `ninja`.
1010
* From the source root `mkdir build` and move into the directory.
1111
* `cmake -G Ninja ../`. This should check you development environment for required packages, download the Flutter engine artifacts and unpack the same in the build directory.
1212
* `ninja` to build the embedder.
13-
* Run the embedder using `./flutter_wayland`. Make sure `weston` is running.
13+
* Run the embedder using `./flutter_wayland`. Make sure `weston` is running. See the instructions on running Flutter applications below.
14+
15+
Running Flutter Applications
16+
----------------------------
17+
18+
```
19+
Flutter Wayland Embedder
20+
========================
21+
22+
Usage: `flutter_wayland <asset_bundle_path> <flutter_flags>`
23+
24+
This utility runs an instance of a Flutter application and renders using
25+
Wayland core protocols.
26+
27+
The Flutter tools can be obtained at https://flutter.io/
28+
29+
asset_bundle_path: The Flutter application code needs to be snapshotted using
30+
the Flutter tools and the assets packaged in the appropriate
31+
location. This can be done for any Flutter application by
32+
running `flutter build bundle` while in the directory of a
33+
valid Flutter project. This should package all the code and
34+
assets in the "build/flutter_assets" directory. Specify this
35+
directory as the first argument to this utility.
36+
37+
flutter_flags: Typically empty. These extra flags are passed directly to the
38+
Flutter engine. To see all supported flags, run
39+
`flutter_tester --help` using the test binary included in the
40+
Flutter tools.
41+
42+
```

0 commit comments

Comments
 (0)