Skip to content

Commit 5844fb4

Browse files
committed
spell out that developers need to use npm link
1 parent 8257f32 commit 5844fb4

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,24 @@ into the `vector` directory and run your own server.
2222

2323
Development
2424
===========
25-
You can work on any of the source files within Vector with the setup above,
26-
and your changes will cause an instant rebuild. If you also need to make
27-
changes to the react sdk, you can:
25+
26+
For simple tweaks, you can work on any of the source files within Vector with the
27+
setup above, and your changes will cause an instant rebuild.
28+
29+
However, all serious development on Vector happens on the `develop` branch. This typically
30+
depends on the `develop` snapshot versions of `matrix-react-sdk` and `matrix-js-sdk`
31+
too, which isn't expressed in Vector's `package.json`. To do this, check out
32+
the `develop` branches of these libraries and then use `npm link` to tell Vector
33+
about them:
2834

2935
1. Link the react sdk package into the example:
3036
`npm link path/to/your/react/sdk`
3137
2. Start the development rebuilder in your react SDK directory:
3238
`npm start`
3339

40+
Similarly, you may need to `npm link path/to/your/js/sdk` in your `matrix-react-sdk`
41+
directory.
42+
3443
If you add or remove any components from the Vector skin, you will need to rebuild
3544
the skin's index by running, `npm run reskindex`.
3645

0 commit comments

Comments
 (0)