From 5844fb40205eb875be5dfc35917018c068340e87 Mon Sep 17 00:00:00 2001 From: Matthew Hodgson Date: Sun, 25 Oct 2015 11:56:29 +0000 Subject: [PATCH] spell out that developers need to use npm link --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 811f52f2b8..75fba1467a 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,24 @@ into the `vector` directory and run your own server. Development =========== -You can work on any of the source files within Vector with the setup above, -and your changes will cause an instant rebuild. If you also need to make -changes to the react sdk, you can: + +For simple tweaks, you can work on any of the source files within Vector with the +setup above, and your changes will cause an instant rebuild. + +However, all serious development on Vector happens on the `develop` branch. This typically +depends on the `develop` snapshot versions of `matrix-react-sdk` and `matrix-js-sdk` +too, which isn't expressed in Vector's `package.json`. To do this, check out +the `develop` branches of these libraries and then use `npm link` to tell Vector +about them: 1. Link the react sdk package into the example: `npm link path/to/your/react/sdk` 2. Start the development rebuilder in your react SDK directory: `npm start` +Similarly, you may need to `npm link path/to/your/js/sdk` in your `matrix-react-sdk` +directory. + If you add or remove any components from the Vector skin, you will need to rebuild the skin's index by running, `npm run reskindex`.