mirror of https://github.com/vector-im/riot-web
Merge branch 'develop' of git+ssh://github.com/vector-im/vector-web into matthew/redesign
commit
1ecf0f0183
15
README.md
15
README.md
|
@ -22,15 +22,24 @@ into the `vector` directory and run your own server.
|
||||||
|
|
||||||
Development
|
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
|
For simple tweaks, you can work on any of the source files within Vector with the
|
||||||
changes to the react sdk, you can:
|
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:
|
1. Link the react sdk package into the example:
|
||||||
`npm link path/to/your/react/sdk`
|
`npm link path/to/your/react/sdk`
|
||||||
2. Start the development rebuilder in your react SDK directory:
|
2. Start the development rebuilder in your react SDK directory:
|
||||||
`npm start`
|
`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
|
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`.
|
the skin's index by running, `npm run reskindex`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue