From 96e74bbb41b24baf7e725b5bd06ef72ead9768d1 Mon Sep 17 00:00:00 2001 From: jesswrd Date: Thu, 23 Jan 2025 21:14:38 -0800 Subject: [PATCH] Add to Setup Path Example to Engine README (#162115) Added link to direct to engine setup and a path example. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [ ] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md --- engine/README.md | 4 ++++ .../Setting-up-the-Engine-development-environment.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/engine/README.md b/engine/README.md index 1e57d66d66..c01e1d6c44 100644 --- a/engine/README.md +++ b/engine/README.md @@ -1,5 +1,9 @@ # Flutter Engine +## Setting up the Engine development environment + +See [here](https://github.com/flutter/flutter/blob/master/engine/src/flutter/docs/contributing/Setting-up-the-Engine-development-environment.md#getting-the-source) + ## `gclient` bootstrap Flutter engine uses `gclient` to manage dependencies. diff --git a/engine/src/flutter/docs/contributing/Setting-up-the-Engine-development-environment.md b/engine/src/flutter/docs/contributing/Setting-up-the-Engine-development-environment.md index 3638bd7df8..9d62050d36 100644 --- a/engine/src/flutter/docs/contributing/Setting-up-the-Engine-development-environment.md +++ b/engine/src/flutter/docs/contributing/Setting-up-the-Engine-development-environment.md @@ -50,7 +50,7 @@ Clone the Flutter source code. As of late 2024, the engine source is part of the [Setup a `.gclient` file](../../../../../engine/README.md) in the repository root (the `flutter/flutter` repository root), and run `gclient sync`. -The "Engine Tool" called `et` is useful when working with the engine. It is located in the [`engine/src/flutter/bin`](https://github.com/flutter/flutter/tree/0c3359df8c8342c8907316488b1404a216f215b6/engine/src/flutter/bin) directory. Add this to your `$PATH` in your `.rc` file. +The "Engine Tool" called `et` is useful when working with the engine. It is located in the [`flutter/engine/src/flutter/bin`](https://github.com/flutter/flutter/tree/0c3359df8c8342c8907316488b1404a216f215b6/engine/src/flutter/bin) directory. Add this to your `$PATH` in your `.rc` file: e.g. on UNIX, using `export PATH=/path/to/flutter/engine/src/flutter/bin:$PATH`. ### Additional Steps for Web Engine