Aurora / Docs
Translations

Translating

Learn how to translate the app or the website

Setup#

For this, we suggest cloning our git repository to make sure you can actually test out the translations in real-time. It's not required however.

  1. Clone the git repository: run git clone https://github.com/Daturaxoxo/Aurora.git in a terminal/command prompt.
  2. Navigate to the newly added Aurora folder
  3. Build the application by doing cargo build and run using cargo run

Warning: Requires you to have Rust installed on your computer. You can just choose to skip this step for simplicity if you want to.

Translating the Application#

  • If your language doesn't exist yet: Go to \productions\Langs\lang-codes.json and add your language.
  • If you language exists: Go to \productions\Langs\translations.json and edit your field.

Each item in the application looks like this:

{
    "key": "settings.panel-title",
    "en": "SETTINGS",
    "tr": "AYARLAR",
    "zh": "设置",
    ...
},

Don't edit the key field, or the app won't be able to resolve the translation.

Each language in lang-codes.json gets its own field here.

If you are for example adding Canadian support (why?), you would add "ca": "translated text goes here"

Translating the Website#

Translating the website is unavailable at the moment, check back later!

Translating the README in GitHub#

For this we also recommend forking our GitHub page and creating a pull request at the end.

  1. Fork our GitHub repository > Fork Button
  2. Find the language you want to translate.
    1. If it doesn't exist, create a new one named: "README.{lang-code}.md", e.g: "README.ru.md" for Russian.
    1. If it does exist, find the language you will edit in the list.
  1. Translate the README to the other language, if you added a new language that wasn't in the list edit the language switcher of every language file to link to the language you added.
  2. Create a pull request and wait for us to review it.