Skip to content

Commit d200a03

Browse files
committed
Update yarn link instructions for Yarn v3+
The use of [`yarn link`](https://yarnpkg.com/cli/link) changed after the upgrade to Yarn v3+. It is no longer necessary to run `yarn link` in the client repository. Instead you can just do `yarn link ../path/to/client` in the browser extension repository. Fixes
1 parent de06005 commit d200a03

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

Diff for: README.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -39,20 +39,16 @@ The extension code has a test suite, which you can run using:
3939

4040
Note that the browser extensions are for the most part just a wrapper around the
4141
[Hypothesis client][client]. Depending on what you're interested in working on,
42-
you may need to check out the client repository too. If you do that, you can get
43-
the browser extension repository to use your checked-out `client` repository by
44-
running
42+
you may need to check out the client repository too. Once you have checked out and
43+
built the Hypothesis client, you can use it by running the following command in
44+
the `browser-extension` repository:
4545

46-
yarn link
46+
yarn link ../client
4747

48-
in the `client` repository, and then
49-
50-
yarn link hypothesis
51-
52-
in the `browser-extension` repository. After that, a call to `make build` will use the
53-
built client from the client repository. Please consult the client's
54-
documentation for instructions on building the client in a development
55-
environment.
48+
Where "../client" is the path to your Hypothesis client checkout. After that
49+
a call to `make build` will use the built client from the client repository.
50+
Please consult the client's documentation for instructions on building the
51+
client in a development environment.
5652

5753
**Tip**: To **unlink** your dev browser extension from your dev client run
5854
`yarn unlink hypothesis` in your browser extension directory

0 commit comments

Comments
 (0)