From fffb172152ee633ce4f3949dec686864242685e8 Mon Sep 17 00:00:00 2001 From: Jose Date: Wed, 4 Mar 2020 20:38:04 +0100 Subject: [PATCH] Added instructions in readme file on how to contribute with a new language. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index fcde439..99949b3 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,26 @@ You can also run the bot on [Docker](http://docker.com). This allows easy server migration and automates the download of all dependencies. Look at the [docker specific documentation](docker/README.md) for more details. +### Adding a New Language + +Actual language support is based on external JSON files that contains all bot texts for each language. + +To add support for a new language you must follow next steps: + +1. Fork the project repository, clone it to local and create a new branch to work on it (i.e. named language-support-en). + +2. Copy from one of the existing language JSON files from [here](https://github.com/J-Rios/TLG_JoinCaptchaBot/tree/master/sources/language) to a new one. + +3. Change the name of that file for the language ISO Code of the language that you want. + +4. Translate each text from JSON key values of the file without breaking the JSON format/structure (it should be valid for JSON parsers) and maintaining JSON keys names. Keep commands names in english (i.e. don't translate "START", "HELP"... /start /help ...) and don't remove special characters (like {}, ", ', \n...) too! + +5. Make a pull request of that branch with the new language file into this repository and wait to be accepted. + +6. Then, I will make the integration into source code and actual Bot account (@join_captcha_bot). + +7. Enjoy the new language :) + ### Languages Contributors: - French: [Mathieu H (Aurnytoraink)](https://github.com/Aurnytoraink)