Added instructions in readme file on how to contribute with a new language.

pull/32/head
Jose 2020-03-04 20:38:04 +01:00 zatwierdzone przez GitHub
rodzic d867546515
commit fffb172152
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 20 dodań i 0 usunięć

Wyświetl plik

@ -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)