From 16e12fab8aa2a6b690a81c756383cd142137aad9 Mon Sep 17 00:00:00 2001 From: Robert Long Date: Fri, 1 Oct 2021 11:51:44 -0700 Subject: [PATCH] Update README --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ef665b50..de511027 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,38 @@ Testbed for full mesh video chat. ## Getting Started -You must first run a local Synapse server on port 8008 +`matrix-video-chat` is built against the `robertlong/group-call` branch of both [matrix-js-sdk](https://github.com/matrix-org/matrix-js-sdk/pull/1902) and [matrix-react-sdk](https://github.com/matrix-org/matrix-react-sdk/pull/6848). Because of how these packages are configured and Vite's requirements, you will need to clone them locally and use `yarn link` to stich things together. + +First clone, install, and link `matrix-js-sdk` ``` +git clone https://github.com/matrix-org/matrix-js-sdk.git +cd matrix-js-sdk +git checkout robertlong/group-call +yarn +yarn link +``` + +Then clone, install, link `matrix-js-sdk` into `matrix-react-sdk`, and link `matrix-react-sdk` + +``` +git clone https://github.com/matrix-org/matrix-react-sdk.git +cd matrix-react-sdk +git checkout robertlong/group-call +yarn +yarn link matrix-js-sdk +yarn link +``` + +Next you'll also need [Synapse](https://matrix-org.github.io/synapse/latest/setup/installation.html) installed locally and running on port 8008. + +Finally we can set up this project. + +``` +git clone https://github.com/vector-im/matrix-video-chat.git cd matrix-video-chat yarn +yarn link matrix-js-sdk +yarn link matrix-react-sdk yarn dev ```