diff --git a/README.md b/README.md index e28724b5..310f2590 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,20 @@ yarn start yarn tauri build ``` +# Internationalization + +Translations are stored in `src/locales/translations`. To update an existing +language, edit the matching file in that directory. + +To add a new language: + +1. Copy `src/locales/translations/en.ts` to a new file named after the language + code, for example `src/locales/translations/fr.ts`. +2. Translate the string values while keeping the translation keys unchanged. +3. Register the new language in `src/locales/index.ts` by adding it to + `loadTranslation`, `LanguageType`, and `LANGUAGE_METADATA`. +4. Check that the language appears in the launcher settings. + # Donations While open.mp is a totally free project and everyone in the team dedicates their time on this project to provide the best for the community, we can still use whatever contribution by anyone, to cover our costs or motivate developers.