diff options
| -rw-r--r-- | doc/i18n.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/i18n.md b/doc/i18n.md index 2eccc7e4..224bcb3e 100644 --- a/doc/i18n.md +++ b/doc/i18n.md @@ -4,6 +4,8 @@ CoinOS can be translated into other languages by editing [JSON](https://www.json _NOTE: This guide was written for people without a technical background. If you want more technical details, click [here](./i18n-technical.md)._ +These instructions assume you have a GitHub account and have permission to modify this repository. If you do not have permission, you will need to [make a fork](https://github.com/coinos/coinos-ui-v2/fork) using the link on the top-right, then follow these instructions to translate your fork, then make a pull request using the link below the "Code" button to apply your changes to the main repository. + Last Updated: 2022-08-23 ## Required Background Knowledge @@ -102,3 +104,11 @@ Follow these steps to add to an existing translation. You will also need a GitHu _NOTE: "CoinOS" is a feminine noun in languages with grammatical gender._ 8. Repeat steps 3-7 for every piece of text you want to translate (you should probably open `en.json` in another tab, so that your changes from step 6 aren't erased). 9. Scroll down and use the green button to commit the file. + +## The Guided Translation Script + +There is also a program that helps you translate automatically - all you have to do is input the translated text and it will do the rest for you! You need a bit of technical knowledge to use it however, specifically, you need to know: +- How to use basic [git](https://git-scm.com/) (cloning, pulling, committing, pushing) +- How to run a [Python](https://www.python.org/) script + +Clone the repository, then use the guided translation script (at `src/locales/guided_translation.py`) to update the translation files. You will need to pull before running, and commit/push your changes in order for them to be applied to CoinOS. |