create README for lang/ - how to update translations

Signed-off-by: Kipras Melnikovas <kipras@kipras.org>
This commit is contained in:
Kipras Melnikovas 2023-01-06 05:00:28 +02:00
parent 9ee6fb994c
commit ecc4e0b889
1 changed files with 19 additions and 0 deletions

19
lang/README.md Normal file
View File

@ -0,0 +1,19 @@
### how to update
1. find missing keys:
```sh
MINE=<your-lang>.json
BASE=en-US.json
jq 'keys' < $BASE > base
jq 'keys' < $MINE > mine
diff -c2 base mine
# will print missing keys.
# add them to $MINE
```
2. for each key, search in your editor where it is used, and additionally visit the [live demo website](https://app.umami.is/share/8rmHaheU/umami.is), to better understand the usage context.
3. translate. though, if you don't fully understand the context of how a translation is used, note this in the PR review.