Skip to content

Commit b99b647

Browse files
jryansjryans
authored
Merge pull request element-hq#14973 from Weasy666/develop
Update links in README.md to point to Element
2 parents 3d8fe4a + a5fd311 commit b99b647

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread
8383
1. Install or update `node.js` so that your `node` is at least v10.x.
8484
1. Install `yarn` if not present already.
8585
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`.
8787
1. Install the prerequisites: `yarn install`.
8888
* If you're using the `develop` branch, then it is recommended to set up a
8989
proper development environment (see [Setting up a dev
@@ -126,31 +126,31 @@ override the desktop app's default settings if desired.
126126
Running from Docker
127127
===================
128128

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
130130
it is to use the prebuilt image:
131131
```bash
132132
docker run -p 80:80 vectorim/riot-web
133133
```
134134

135135
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
137137
would be:
138138
```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
140140
```
141141

142142
To build the image yourself:
143143
```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
146146
git checkout master
147-
docker build -t vectorim/riot-web .
147+
docker build .
148148
```
149149

150150
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:
152152
```bash
153-
docker build -t vectorim/riot-web:develop \
153+
docker build -t \
154154
--build-arg USE_CUSTOM_SDKS=true \
155155
--build-arg REACT_SDK_REPO="https://github.com/matrix-org/matrix-react-sdk.git" \
156156
--build-arg REACT_SDK_BRANCH="develop" \
@@ -169,7 +169,7 @@ Labs Features
169169
=============
170170

171171
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).
173173

174174
Caching requirements
175175
====================
@@ -186,13 +186,13 @@ Element requires the following URLs not to be cached, when/if you are serving El
186186
Development
187187
===========
188188

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
190190
for `matrix-react-sdk`](https://github.com/matrix-org/matrix-react-sdk#developer-guide), which
191191
also defines the design, architecture and style for Element too.
192192

193193
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
196196
start so we can ensure it's something we'd be willing to merge.
197197

198198
You should also familiarise yourself with the ["Here be Dragons" guide
@@ -246,8 +246,8 @@ popd
246246
Finally, build and start Element itself:
247247

248248
```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
251251
git checkout develop
252252
yarn link matrix-js-sdk
253253
yarn link matrix-react-sdk
@@ -275,7 +275,7 @@ bundle.css.map 116 kB 0 [emitted] main
275275
Configure the app by copying `config.sample.json` to `config.json` and
276276
modifying it. See the [configuration docs](docs/config.md) for details.
277277

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.
279279

280280
**Note**: The build script uses inotify by default on Linux to monitor directories
281281
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).
336336

337337
For a developer guide, see the [translating dev doc](docs/translating-dev.md).
338338

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)
340340

341341
Triaging issues
342342
===============

0 commit comments

Comments
 (0)