diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c6c571..d0b4a91 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## next version + +### Features: +* Add Information about how to create translations to CONTRIBUTE.md ([#PR35](https://github.com/WhereGroup/qgis2mapbender/pull/35)) + + ## v1.1.0 ### Features: diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 568e547..6fc6b27 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -1,3 +1,19 @@ # Contribute Contributors are welcome to extend the plugin's features further. Please fork the repository and make a pull request if your feature is ready. Just creating issues also helps to maintain the plugin working. Please, provide a meaningful example. + +## Translations + +Translation files are placed in the folder i18n of the plugin. + +You can copy an existing .ts file and translate it to your language (sections translation). +Please name the new file according to the following scheme: `xx.ts`, where `xx` is the [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of your language (e.g. `de` for German, `es` for Spanish, `it` for Italian, etc.). +You can use [Qt Linguist](https://doc.qt.io/qt-5/qtlinguist-index.html) to translate the strings in the .ts file. + +You have to create a .qm file from the .ts file after translating it. You can use the `lrelease` tool from the Qt framework to do this. The command is as follows: + +``` +lrelease path/to/yourfile.ts +``` + +After translating the strings in the .ts file and the creation of the .qm file, please create a pull request with your new translation file included in the i18n folder of the repository. This way, your translation can be included in future releases of the plugin. \ No newline at end of file diff --git a/README.md b/README.md index c952e23..ae337fd 100644 --- a/README.md +++ b/README.md @@ -80,3 +80,6 @@ info@wheregroup.com ## License The plugin is licensed under the attached GNU General Public License. + +## Translations +Translation files are placed in the folder i18n of the plugin. If you want to contribute a translation, please have a look at the CONTRIBUTE.md file. \ No newline at end of file