Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Commit

Permalink
Merge pull request #2404 from jaywink/jaywink/improve-readme-for-devs
Browse files Browse the repository at this point in the history
Clarify readme instructions for developers
  • Loading branch information
turt2live authored Jan 7, 2019
2 parents a7c9d4e + 633b8d4 commit 5fb6da8
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 (v8.x is the best choice). 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
```

0 comments on commit 5fb6da8

Please sign in to comment.