@@ -83,7 +83,7 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread
83
83
1 . Install or update ` node.js ` so that your ` node ` is at least v10.x.
84
84
1 . Install ` yarn ` if not present already.
85
85
1 . Clone the repo: ` git clone https://github.com/vector-im/element-web.git ` .
86
- 1 . Switch to the riot -web directory: ` cd riot -web ` .
86
+ 1 . Switch to the element -web directory: ` cd element -web ` .
87
87
1 . Install the prerequisites: ` yarn install ` .
88
88
* If you're using the ` develop ` branch, then it is recommended to set up a
89
89
proper development environment (see [ Setting up a dev
@@ -126,31 +126,31 @@ override the desktop app's default settings if desired.
126
126
Running from Docker
127
127
===================
128
128
129
- The Docker image can be used to serve riot -web as a web server. The easiest way to use
129
+ The Docker image can be used to serve element -web as a web server. The easiest way to use
130
130
it is to use the prebuilt image:
131
131
``` bash
132
132
docker run -p 80:80 vectorim/riot-web
133
133
```
134
134
135
135
To supply your own custom ` config.json ` , map a volume to ` /app/config.json ` . For example,
136
- if your custom config was located at ` /etc/riot -web/config.json ` then your Docker command
136
+ if your custom config was located at ` /etc/element -web/config.json ` then your Docker command
137
137
would be:
138
138
``` bash
139
- docker run -p 80:80 -v /etc/riot -web/config.json:/app/config.json vectorim/riot-web
139
+ docker run -p 80:80 -v /etc/element -web/config.json:/app/config.json vectorim/riot-web
140
140
```
141
141
142
142
To build the image yourself:
143
143
``` bash
144
- git clone https://github.com/vector-im/riot -web.git riot -web
145
- cd riot -web
144
+ git clone https://github.com/vector-im/element -web.git element -web
145
+ cd element -web
146
146
git checkout master
147
- docker build -t vectorim/riot-web .
147
+ docker build .
148
148
```
149
149
150
150
If you're building a custom branch, or want to use the develop branch, check out the appropriate
151
- riot -web branch and then run:
151
+ element -web branch and then run:
152
152
``` bash
153
- docker build -t vectorim/riot-web:develop \
153
+ docker build -t \
154
154
--build-arg USE_CUSTOM_SDKS=true \
155
155
--build-arg REACT_SDK_REPO=" https://github.com/matrix-org/matrix-react-sdk.git" \
156
156
--build-arg REACT_SDK_BRANCH=" develop" \
@@ -169,7 +169,7 @@ Labs Features
169
169
=============
170
170
171
171
Some features of Element may be enabled by flags in the ` Labs ` section of the settings.
172
- Some of these features are described in [ labs.md] ( https://github.com/vector-im/riot -web/blob/develop/docs/labs.md ) .
172
+ Some of these features are described in [ labs.md] ( https://github.com/vector-im/element -web/blob/develop/docs/labs.md ) .
173
173
174
174
Caching requirements
175
175
====================
@@ -186,13 +186,13 @@ Element requires the following URLs not to be cached, when/if you are serving El
186
186
Development
187
187
===========
188
188
189
- Before attempting to develop on Riot you ** must** read the [ developer guide
189
+ Before attempting to develop on Element you ** must** read the [ developer guide
190
190
for ` matrix-react-sdk ` ] ( https://github.com/matrix-org/matrix-react-sdk#developer-guide ) , which
191
191
also defines the design, architecture and style for Element too.
192
192
193
193
Before starting work on a feature, it's best to ensure your plan aligns well
194
- with our vision for Riot . Please chat with the team in
195
- [ #riot -dev: matrix .org] ( https://matrix.to/#/#riot -dev:matrix.org ) before you
194
+ with our vision for Element . Please chat with the team in
195
+ [ #element -dev: matrix .org] ( https://matrix.to/#/#element -dev:matrix.org ) before you
196
196
start so we can ensure it's something we'd be willing to merge.
197
197
198
198
You should also familiarise yourself with the [ "Here be Dragons" guide
246
246
Finally, build and start Element itself:
247
247
248
248
``` bash
249
- git clone https://github.com/vector-im/riot -web.git
250
- cd riot -web
249
+ git clone https://github.com/vector-im/element -web.git
250
+ cd element -web
251
251
git checkout develop
252
252
yarn link matrix-js-sdk
253
253
yarn link matrix-react-sdk
@@ -275,7 +275,7 @@ bundle.css.map 116 kB 0 [emitted] main
275
275
Configure the app by copying ` config.sample.json ` to ` config.json ` and
276
276
modifying it. See the [ configuration docs] ( docs/config.md ) for details.
277
277
278
- Open http://127.0.0.1:8080/ in your browser to see your newly built Riot .
278
+ Open http://127.0.0.1:8080/ in your browser to see your newly built Element .
279
279
280
280
** Note** : The build script uses inotify by default on Linux to monitor directories
281
281
for changes. If the inotify watch limit is too low your build will silently fail.
@@ -336,7 +336,7 @@ To add a new translation, head to the [translating doc](docs/translating.md).
336
336
337
337
For a developer guide, see the [ translating dev doc] ( docs/translating-dev.md ) .
338
338
339
- [ <img src =" https://translate.riot.im/widgets/riot -web/-/multi-auto.svg " alt =" translationsstatus " width =" 340 " >] ( https://translate.riot.im/engage/riot -web/?utm_source=widget )
339
+ [ <img src =" https://translate.riot.im/widgets/element -web/-/multi-auto.svg " alt =" translationsstatus " width =" 340 " >] ( https://translate.riot.im/engage/element -web/?utm_source=widget )
340
340
341
341
Triaging issues
342
342
===============
0 commit comments