mirror of
https://github.com/vector-im/element-web.git
synced 2024-11-16 13:14:58 +08:00
update README
This commit is contained in:
parent
b3473a7220
commit
a4e7b14728
12
README.md
12
README.md
@ -34,18 +34,16 @@ puppeteer.launch({headless: false});
|
||||
## How to run
|
||||
|
||||
### Setup
|
||||
- install synapse with `sh synapse/install.sh`, this fetches the master branch at the moment. If anything fails here, please refer to the synapse README to see if you're missing one of the prerequisites.
|
||||
- install riot with `sh riot/install.sh`, this fetches the master branch at the moment.
|
||||
- install dependencies with `npm install` (will download copy of chrome)
|
||||
- have riot-web running on `localhost:8080`
|
||||
- have a local synapse running at `localhost:8008`
|
||||
|
||||
Run `sh install.sh`. This will:
|
||||
- install synapse, fetches the master branch at the moment. If anything fails here, please refer to the synapse README to see if you're missing one of the prerequisites.
|
||||
- install riot, this fetches the master branch at the moment.
|
||||
- install dependencies (will download copy of chrome)
|
||||
|
||||
### Run tests
|
||||
|
||||
Run tests with `sh run.sh`.
|
||||
|
||||
You should see the terminal split with on top the server output (both riot static server, and synapse), and on the bottom the tests running.
|
||||
|
||||
Developer Guide
|
||||
===============
|
||||
|
||||
|
3
install.sh
Normal file
3
install.sh
Normal file
@ -0,0 +1,3 @@
|
||||
sh synapse/install.sh
|
||||
sh riot/install.sh
|
||||
npm install
|
Loading…
Reference in New Issue
Block a user