Skip to content
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

docs: update building instructions to reflect current branching strategy #17

Merged
merged 1 commit into from
May 15, 2023
Merged

docs: update building instructions to reflect current branching strategy #17

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
15 changes: 12 additions & 3 deletions BUILDING_ENGINE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,22 @@ These steps assume that you have [installed the dependencies for building the Fl
- Move to the `engine` directory.
- Paste the context of https://raw.githubusercontent.com/shorebirdtech/build_engine/main/build_engine/dot_gclient into a file named `.gclient`.
- Run `gclient sync` to download the Flutter engine source code (this will take a while).
- Move to the `src/flutter` directory.
- Run `git checkout flutter-release/X.Y.Z` to checkout the version of the Flutter engine that Shorebird uses.
- X.Y.Z is currently 3.10.0.
- Move back to the `src` directory.
- Run `gclient sync` again.

Or, as one set of commands:

```bash
mkdir engine && \
cd engine && \
curl https://raw.githubusercontent.com/shorebirdtech/build_engine/main/build_engine/dot_gclient > .gclient && \
gclient sync &&
cd src/flutter &&
git checkout flutter-release/3.10.0 &&
cd .. &&
gclient sync
```

Expand All @@ -82,7 +91,7 @@ Build `host_release`:

```bash
cd src && \
./flutter/tools/gn --runtime-mode=release && \
./flutter/tools/gn --runtime-mode=release --no-goma && \
ninja -C out/host_release && \
say "done"
```
Expand All @@ -91,7 +100,7 @@ Build the engine for Android arm64:

```bash
cd src && \
./flutter/tools/gn --android --android-cpu arm64 --runtime-mode=release && \
./flutter/tools/gn --android --android-cpu arm64 --runtime-mode=release --no-goma && \
cd third_party/updater && \
cargo ndk --target aarch64-linux-android build --release && \
ninja -C ../../out/android_release_arm64 && \
Expand All @@ -103,7 +112,7 @@ cd src && \
> The "Build the engine for Android arm64" step will eventually be condensed to:
> ```bash
> cd src && \
> ./flutter/tools/gn --android --android-cpu arm64 --runtime-mode=release && \
> ./flutter/tools/gn --android --android-cpu arm64 --runtime-mode=release --no-goma && \
> ninja -C out/android_release_arm64
> ```
> See https://github.com/shorebirdtech/shorebird/issues/463.
Expand Down