Update readme
This commit is contained in:
parent
35f77416ba
commit
3a6c1376fc
|
@ -1,10 +1,9 @@
|
||||||
# Translations
|
# Translations
|
||||||
|
|
||||||
The base translation is `base-en.yaml`. It will always contain the latest phrases and structure.
|
The base language is English and can be found [here](base-en.yaml).
|
||||||
|
|
||||||
## Languages
|
## Languages
|
||||||
|
|
||||||
- [English (Base Language, Source of Truth)](base-en.yaml)
|
|
||||||
- [German](base-de.yaml)
|
- [German](base-de.yaml)
|
||||||
- [French](base-fr.yaml)
|
- [French](base-fr.yaml)
|
||||||
- [Korean](base-kor.yaml)
|
- [Korean](base-kor.yaml)
|
||||||
|
@ -39,15 +38,39 @@ The base translation is `base-en.yaml`. It will always contain the latest phrase
|
||||||
|
|
||||||
If you want to edit an existing translation (Fixing typos, Updating it to a newer version, etc), you can just use the github file editor to edit the file.
|
If you want to edit an existing translation (Fixing typos, Updating it to a newer version, etc), you can just use the github file editor to edit the file.
|
||||||
|
|
||||||
- Find the file you want to edit (For example, `base-de.yaml` if you want to change the german translation)
|
- Click the language you want to edit from the list above
|
||||||
- Click on the file name on, there will be a small "edit" symbol on the top right
|
- Click the small "edit" symbol on the top right
|
||||||
- Do the changes you wish to do (Be sure **not** to translate placeholders!)
|
|
||||||
|
<img src="https://i.imgur.com/gZnUQoe.png" alt="edit symbol" width="200">
|
||||||
|
|
||||||
|
- Do the changes you wish to do (Be sure **not** to translate placeholders! For example, `<amount> minutes` should get `<amount> Minuten` and **not** `<anzahl> Minuten`!)
|
||||||
|
|
||||||
- Click "Propose Changes"
|
- Click "Propose Changes"
|
||||||
- I will review your changes and make comments, and eventually merge them so they will be in the next release!
|
|
||||||
|
<img src="https://i.imgur.com/KT9ZFp6.png" alt="propose changes" width="200">
|
||||||
|
|
||||||
|
- Click "Create pull request"
|
||||||
|
|
||||||
|
<img src="https://i.imgur.com/oVljvRE.png" alt="create pull request" width="200">
|
||||||
|
|
||||||
|
- I will review your changes and make comments, and eventually merge them so they will be in the next release! Be sure to regulary check the created pull request for comments.
|
||||||
|
|
||||||
## Adding a new language
|
## Adding a new language
|
||||||
|
|
||||||
Please DM me on discord (tobspr#5407), so I can add the language template for you. It is not as simple as creating a new file.
|
Please DM me on discord (tobspr#5407), so I can add the language template for you.
|
||||||
|
|
||||||
|
Please use the following template:
|
||||||
|
|
||||||
|
```
|
||||||
|
Hey, could you add a new translation?
|
||||||
|
|
||||||
|
Language: <Language, e.g. 'German'>
|
||||||
|
Short code: <Short code, e.g. 'de', see below>
|
||||||
|
Local Name: <Name of your Language, e.g. 'Deutsch'>
|
||||||
|
```
|
||||||
|
|
||||||
|
You can find the short code [here](https://www.science.co.il/language/Codes.php) (In column `Code 2`).
|
||||||
|
|
||||||
PS: I'm super busy, but I'll give my best to do it quickly!
|
PS: I'm super busy, but I'll give my best to do it quickly!
|
||||||
|
|
||||||
## Updating a language to the latest version
|
## Updating a language to the latest version
|
||||||
|
|
Reference in New Issue