shapez/translations/README.md

81 lines
2.7 KiB
Markdown
Raw Normal View History

2020-06-10 12:30:31 +02:00
# Translations
2020-06-10 12:35:37 +02:00
2020-07-07 13:47:31 +02:00
The base language is English and can be found [here](base-en.yaml).
2020-06-10 12:35:37 +02:00
2020-06-10 14:04:08 +02:00
## Languages
- [German](base-de.yaml)
- [French](base-fr.yaml)
- [Korean](base-kor.yaml)
- [Dutch](base-nl.yaml)
- [Polish](base-pl.yaml)
- [Portuguese (Brazil)](base-pt-BR.yaml)
2020-06-10 17:28:00 +02:00
- [Portuguese (Portugal)](base-pt-PT.yaml)
2020-06-10 14:04:08 +02:00
- [Russian](base-ru.yaml)
2020-06-10 14:13:22 +02:00
- [Greek](base-el.yaml)
2020-06-10 17:25:50 +02:00
- [Italian](base-it.yaml)
2020-06-10 17:28:45 +02:00
- [Romanian](base-ro.yaml)
2020-06-10 17:29:36 +02:00
- [Swedish](base-sv.yaml)
2020-06-10 17:30:44 +02:00
- [Chinese (Simplified)](base-zh-CN.yaml)
- [Chinese (Traditional)](base-zh-TW.yaml)
- [Spanish](base-es.yaml)
- [Hungarian](base-hu.yaml)
2020-06-11 12:03:10 +02:00
- [Turkish](base-tr.yaml)
2020-06-11 14:15:12 +02:00
- [Japanese](base-ja.yaml)
2020-06-12 10:03:06 +02:00
- [Lithuanian](base-lt.yaml)
- [Arabic](base-ar.yaml)
2020-06-13 15:04:42 +02:00
- [Norwegian](base-no.yaml)
2020-06-21 18:04:35 +02:00
- [Kroatian](base-hr.yaml)
2020-06-25 12:18:48 +02:00
- [Danish](base-da.yaml)
2020-06-29 00:12:43 +02:00
- [Finnish](base-fi.yaml)
2020-07-02 09:48:15 +02:00
- [Catalan](base-cat.yaml)
2020-07-06 14:03:50 +02:00
- [Slovenian](base-sl.yaml)
2020-07-07 07:11:39 +02:00
- [Ukrainian](base-uk.yaml)
2020-07-13 22:46:44 +02:00
- [Indonesian](base-ind.yaml)
2020-07-18 15:54:01 +02:00
- [Serbian](base-sr.yaml)
2020-06-10 14:04:08 +02:00
(If you want to translate into a new language, see below!)
2020-06-10 12:35:37 +02:00
## Editing existing translations
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.
2020-07-07 13:47:31 +02:00
- Click the language you want to edit from the list above
- Click the small "edit" symbol on the top right
<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`!)
2020-06-10 14:04:08 +02:00
- Click "Propose Changes"
2020-07-07 13:47:31 +02:00
<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.
2020-06-10 12:35:37 +02:00
## Adding a new language
Please DM me on Discord (tobspr#5407), so I can add the language template for you.
2020-07-07 13:47:31 +02:00
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`).
2020-06-10 12:35:37 +02:00
PS: I'm super busy, but I'll give my best to do it quickly!
## Updating a language to the latest version
2020-06-12 11:52:21 +02:00
Run `yarn syncTranslations` in the root directory to synchronize all translations to the latest version! This will remove obsolete keys and add newly added keys. (Run `yarn` before to install packes).