Updated Guide for translators (markdown)

Luke Vella 2022-07-26 19:18:28 +01:00
parent 6c6c9c9f8b
commit 065fe435ec

@ -1,23 +1,13 @@
## Hello!
Rallly is made available in different languages through the contributions of its users and the open-source community. We use [crowdin](https://crowdin.com) to make it easy for anyone to submit translations. If you are interested, please read this guide first.
<img src="https://user-images.githubusercontent.com/676849/180199513-2bb3a960-a191-43fa-957c-e9dcc24465e3.svg" width="300" />
Rallly is made available in different languages through the contributions of its users and the open-source community. We use [crowdin](https://crowdin.com) to make it easy for anyone to submit translations. If you are interested, please read this guide first.
## Getting started
The first thing you need to do is [create a crowdin account](https://accounts.crowdin.com/register). Crowdin offers a user-friendly interface to submit translations. Once you have an account you can join the project here: https://crwd.in/rallly
Currently we are accepting translations for the following languages:
* 🇫🇷 French
* 🇪🇸 Spanish
* 🇩🇪 German
* 🇮🇹 Italian
* 🇸🇪 Swedish
If you would like to submit translations in another language please reach out via [discord](https://discord.gg/m5UFXavc2C) or send an email to [luke@rallly.co](mailto:luke@rallly.co).
Once you've joined the project:
1. Pick the language you'd like to translate
2. Select a file (each file contains text for different parts of the site)
@ -25,6 +15,19 @@ Once you've joined the project:
<img width="500" alt="CleanShot 2022-07-21 at 12 05 59@2x" src="https://user-images.githubusercontent.com/676849/180199933-4e507c8e-0e9a-498a-99c8-a7ad44cb7ded.png">
### FAQ
#### What if my language is already translated?
You should still join the project! When new translations are added you will be notified to help translate them.
#### What if I don't see my language?
If you don't see your language in Crowdin and would like to submit translations please reach out via [discord](https://discord.gg/m5UFXavc2C) or send an email to [luke@rallly.co](mailto:luke@rallly.co).
#### How quickly will my translations get released?
Usually, this is done within a few hours of submitting your translations. This is because Crowdin will check for updates once every hour and the updates need to be manually approved.
## When translating