PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Clarify readme instructions for developers

Browse source 
Setting up the SDK for development, I noticed that 3 tests failed on
develop branch. Linking the JS SDK made the tests pass. It looks like
the assumption is that developers link against the develop branch
of JS SDK to develop the React SDK.

Clarify this in the readme for completeness sake.

Signed-off-by: Jason Robinson <jasonr@matrix.org>
This commit is contained in:
Jason Robinson 2019-01-04 10:51:39 +02:00
parent c11d0bdf0c
commit e876edcbc3
1 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -127,3 +127,36 @@ Github Issues
All issues should be filed under https://github.com/vector-im/riot-web/issues
for now.
Development
===========
Ensure you have the latest stable Node JS runtime installed. Then check out
the code and pull in dependencies:
```bash
git clone https://github.com/matrix-org/matrix-react-sdk.git
cd matrix-react-sdk
git checkout develop
npm install
```
`matrix-react-sdk` depends on `matrix-js-sdk`. To make use of changes in the
latter and to ensure tests run against the develop branch of `matrix-js-sdk`,
you should run the following which will sync changes from the JS sdk here.
```bash
npm link ../matrix-js-sdk
```
Command assumes a checked out and installed `matrix-js-sdk` folder in parent
folder.
Running tests
=============
Ensure you've followed the above development instructions and then:
```bash
npm run test
```