Skip to content

Commit

Permalink
Better explain how to use a local engine
Browse files Browse the repository at this point in the history
Added a section which explains how to get `dart:ui` changes.
  • Loading branch information
eseidelGoogle authored Jul 6, 2016
1 parent 834d81e commit af054a4
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,19 @@ target_os = ["android"]
Building and running the code
-----------------------------

### General

Most developers will use the `flutter` tool in [the main Flutter repository](https://github.com/flutter/flutter) for interacting with their built flutter/engine. To do so, the `flutter` tool accepts two global parameters `local-engine-src-path` and `local-engine`, a typical invocation would be: `--local-engine-src-path /path/to/engine/src --local-engine=android_debug_unopt`.

Additionally if you've modified dart sources in `flutter/engine`, you'll need to add a `dependency_overrides` section to point to your modified `package:sky_engine` and `package:sky_services` to the `pubspec.yaml` for the flutter app you're using the custom engine with. A typical example would be:
```
dependency_overrides:
sky_engine:
path: /path/to/flutter/engine/out/host_debug/gen/dart-pkg/sky_engine
sky_services:
path: /path/to/flutter/engine/out/host_debug/gen/dart-pkg/sky_services
```

### Android (cross-compiling from Mac or Linux)

Run the following steps, from the `src` directory created in the steps above:
Expand Down

0 comments on commit af054a4

Please sign in to comment.