Skip to content

Commit 2e3a459

Browse files
committed
doc: update CONTRIBUTING.md with new build.
1 parent 7c5d30e commit 2e3a459

3 files changed

Lines changed: 15 additions & 21 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,41 +22,33 @@ git submodule update --init --recursive
2222
$ npm install
2323
```
2424

25-
## Building bridge
25+
## Prepare
2626

27-
> Debug is the default build type, if you want to have a release build, please add `:release` after your command.
28-
>
29-
> Exp: Execute `npm run build:bridge:macos:release` to build a release bridge for the macOS platform.
27+
**Windows, Linux, Android**
3028

31-
**Windows**
29+
The current C/C++ code build process has been integrated into Flutter's compilation and build pipeline for Windows, Linux, and Android.
3230

33-
```shell
34-
$ npm run build:bridge:windows:release
35-
```
36-
37-
**macOS**
31+
Run the following script to generate C/C++ binding code using the code generator:
3832

3933
```shell
40-
$ npm run build:bridge:macos:release
34+
npm run generate_binding_code
4135
```
4236

43-
**linux**
37+
---
4438

45-
```shell
46-
$ npm run build:bridge:linux:release
47-
```
39+
**iOS and macOS**
4840

49-
**iOS**
41+
> The default build type is Debug. To create a release build, add `:release` to your command.
42+
>
43+
> Example: Execute `npm run build:bridge:macos:release` to build a release bridge for macOS.
5044
5145
```shell
52-
$ npm run build:bridge:ios:release
46+
$ npm run build:bridge:ios:release # iOS
47+
$ npm run build:bridge:macos:release # macOS
5348
```
5449

55-
**Android**
50+
---
5651

57-
```shell
58-
$ npm run build:bridge:android:release
59-
```
6052

6153
### Run Example
6254

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
"build:bridge:all": "node scripts/prepare_webf_release_binary",
1919
"build:bridge:all:release": "WEBF_BUILD=Release node scripts/prepare_webf_release_binary",
2020
"build_bridge:all:profile": "ENABLE_PROFILE=true npm run build:bridge:all:release",
21+
"generate_binding_code": "node scripts/generate_binding_code",
2122
"build:clean": "node scripts/clean.js",
2223
"pretest": "npm install && node scripts/build_darwin_dylib",
2324
"posttest": "npm run lint",

scripts/generate_binding_code.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ require('./tasks');
88

99
// Run tasks
1010
series(
11+
'compile-polyfill',
1112
'generate-bindings-code',
1213
)((err) => {
1314
if (err) {

0 commit comments

Comments
 (0)