Skip to content

Commit 5583f62

Browse files
committed
Update Development Section
1 parent 1df5872 commit 5583f62

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

README.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,8 @@ If you'd like to help translate Element Call, head over to
143143
the [Element Translators](https://matrix.to/#/#translators:element.io) space to
144144
discuss and coordinate translation efforts.
145145

146-
## Development
146+
147+
## 🛠️ Development
147148

148149
### Frontend
149150

@@ -155,13 +156,15 @@ cd element-call
155156
yarn
156157
```
157158

158-
To use it, create a local config by, e.g., `cp ./config/config.devenv.json ./public/config.json`
159-
and adapt it if necessary. The `config.devenv.json` config should work with the backend
160-
development environment as outlined in the next section out of box.
159+
To use it, create a local config by, e.g.,
160+
`cp ./config/config.devenv.json ./public/config.json` and adapt it if necessary.
161+
The `config.devenv.json` config should work with the backend development
162+
environment as outlined in the next section out of box.
161163

162-
(Be aware, that this `config.devenv.json` is exposing a deprecated fallback
164+
> [!NOTE]
165+
> Be aware, that this `config.devenv.json` is exposing a deprecated fallback
163166
LiveKit config key. If the homeserver advertises SFU backend via
164-
`.well-known/matrix/client` this has precedence.)
167+
`.well-known/matrix/client` this has precedence.
165168

166169
You're now ready to launch the development server:
167170

@@ -196,11 +199,13 @@ yarn backend
196199

197200
<img src="https://codecov.io/github/element-hq/element-call/graphs/tree.svg?token=O6CFVKK6I1"></img>
198201

202+
199203
### Add a new translation key
200204

201205
To add a new translation key you can do these steps:
202206

203-
1. Add the new key entry to the code where the new key is used: `t("some_new_key")`
207+
1. Add the new key entry to the code where the new key is used:
208+
`t("some_new_key")`
204209
1. Run `yarn i18n` to extract the new key and update the translation files. This
205210
will add a skeleton entry to the `locales/en/app.json` file:
206211

@@ -212,18 +217,18 @@ To add a new translation key you can do these steps:
212217
}
213218
```
214219

215-
1. Update the skeleton entry in the `locales/en/app.json` file with
216-
the English translation:
220+
1. Update the skeleton entry in the `locales/en/app.json` file with the English
221+
translation:
222+
223+
```jsonc
224+
{
225+
...
226+
"some_new_key": "Some new key",
227+
...
228+
}
229+
```
217230

218-
```jsonc
219-
{
220-
...
221-
"some_new_key": "Some new key",
222-
...
223-
}
224-
```
225231

226-
## Documentation
227232

228233
Usage and other technical details about the project can be found here:
229234

0 commit comments

Comments
 (0)