Skip to content

Commit 1dae77e

Browse files
chore(docs): update mediapipe repo path
1 parent f788847 commit 1dae77e

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,21 +61,22 @@ As described above, switch to the `master` channel to work on or use the various
6161
```sh
6262
$ flutter channel master
6363
$ flutter doctor
64+
$ flutter pub get
6465
```
6566

66-
#### Checking out the `google/mediapipe` repository
67+
#### Checking out the `google-ai-edge/mediapipe` repository
6768

6869
Some of `google/flutter-mediapipe` repository's tooling requires a local checkout
69-
of the `google/mediapipe` repository. By default, this tooling assumes both
70+
of the `google-ai-edge/mediapipe` repository. By default, this tooling assumes both
7071
repositories are colocated within the same directory, but if you prefer to
71-
checkout the `google/mediapipe` repository elsewhere, then you can specify its
72+
checkout the `google-ai-edge/mediapipe` repository elsewhere, then you can specify its
7273
absolute path on your machine via the `--source` or `-s` flag.
7374

7475
#### Updating header files
7576

76-
The reason a local checkout of `google/mediapipe` is required is that
77+
The reason a local checkout of `google-ai-edge/mediapipe` is required is that
7778
`google/flutter-mediapipe` uses copies of header files found in the former. To
78-
sync the latest versions of all header files from `google/mediapipe` to
79+
sync the latest versions of all header files from `google-ai-edge/mediapipe` to
7980
`google/flutter-mediapipe`, run the `sync_headers` command found in the `tool`
8081
directory like so:
8182

@@ -101,11 +102,11 @@ MediaPipe library will ever encounter, so do not hesitate to modify `relativeInc
101102
or add a new function if necessary.
102103

103104
Once you have modified this script, re-run the headers command to pull your new files
104-
out of `google/mediapipe` and into `google/flutter-mediapipe`. Pre-existing header
105+
out of `google-ai-edge/mediapipe` and into `google/flutter-mediapipe`. Pre-existing header
105106
files should not have any changes, but your new files should appear.
106107

107108
If pre-existing header files do change because they have genuinely evolved within
108-
`google/mediapipe` since anyone else last ran the command, those changes should be
109+
`google-ai-edge/mediapipe` since anyone else last ran the command, those changes should be
109110
resolved within their own PR.
110111

111112
#### Running ffigen
@@ -171,7 +172,7 @@ It is finally time to write some Dart code!
171172

172173
If you are contributing a new task, you should have added new header files to the
173174
`sync_headers.dart` script and run the command yourself. This should have copied
174-
those specified headers out of `google/mediapipe` and into your git clone of
175+
those specified headers out of `google-ai-edge/mediapipe` and into your git clone of
175176
`google/flutter-mediapipe`. To begin implementing your new MediaPipe task, add
176177
a new folder to the appropriate `<pkg_name>/lib/src/interface/tasks/` directory and
177178
add apporpriate exports to the `tasks.dart` barrel file. Then add abstract

0 commit comments

Comments
 (0)