Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit b790d48

Browse files
authored
README for the felt tool (#12323)
1 parent b4d7655 commit b790d48

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

lib/web_ui/dev/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## What's `felt`?
2+
`felt` stands for "Flutter Engine Local Tester". It's a cli tool that aims to make development in the Flutter web engine more productive and pleasant.
3+
4+
## What can `felt` do?
5+
`felt` supports multiple commands as follows:
6+
7+
1. **`felt check-licenses`**: Checks that all Dart and JS source code files contain the correct license headers.
8+
2. **`felt test`**: Runs all or some tests depending on the passed arguments.
9+
3. **`felt build`**: Builds the engine locally so it can be used by Flutter apps. It also supports a watch mode for more convenience.
10+
11+
You could also run `felt help` or `felt help <command>` to get more information about the available commands and arguments.
12+
13+
## How can I use `felt`?
14+
Once you have your local copy of the engine [setup](https://github.com/flutter/flutter/wiki/Setting-up-the-Engine-development-environment), you'll need to add `/path/to/engine/src/flutter/lib/web_ui/dev` to your `PATH`.
15+
Then you would be able to use the `felt` tool from anywhere:
16+
```
17+
felt check-licenses
18+
```
19+
or:
20+
```
21+
felt build --watch
22+
```

lib/web_ui/dev/felt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,10 @@ then
4545
ninja -C $HOST_DEBUG_UNOPT_DIR
4646
fi
4747

48+
echo "Running \`pub get\` in 'engine/src/flutter/lib/web_ui'"
49+
(cd "$WEB_UI_DIR"; $DART_SDK_DIR/bin/pub get)
50+
51+
echo "Running \`pub get\` in 'engine/src/flutter/web_sdk/web_engine_tester'"
52+
(cd "$FLUTTER_DIR/web_sdk/web_engine_tester"; $DART_SDK_DIR/bin/pub get)
53+
4854
$DART_SDK_DIR/bin/dart "$DEV_DIR/felt.dart" $@

0 commit comments

Comments
 (0)