From 9382532dc2c147e72f83a9035a9acb54a238e4c8 Mon Sep 17 00:00:00 2001 From: Lex Neva Date: Wed, 22 Aug 2018 14:00:41 -0400 Subject: [PATCH] Update LOCALIZATION.md --- LOCALIZATION.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/LOCALIZATION.md b/LOCALIZATION.md index d692b38cf..b8eb19a25 100644 --- a/LOCALIZATION.md +++ b/LOCALIZATION.md @@ -1,24 +1,41 @@ -ink/stitch Localization +Ink/Stitch Localization ======================= -The goal of the ink/stitch project is to put free, high-quality embroidery design tools in the hands of folks that might normally not have access to such tools. To further that goal, we seek to support as many languages and locales as possible. +The goal of the Ink/Stitch project is to put free, high-quality embroidery design tools in the hands of folks that might normally not have access to such tools. To further that goal, we seek to support as many languages and locales as possible. -Ink/stitch supports displaying text in the user's preferred language in the Params dialog and in error messages displayed by the Embroider extension. Future work will add translations for the extension settings window (displayed by Inkscape) and project documentation (such as this file). +Ink/Stitch supports displaying text in the user's preferred language in the following places: + * dialogs (such as Params and Install Add-Ons for Inkscape) + * print PDF + * error messages + * extension settings dialogs and menu items + * these are managed by Inkscape + +Future work will add translations for project documentation (such as this file) and the Ink/Stitch website. Help wanted! ----------- -Want to help translate? We'd really appreciate your contributions! Ink/stitch uses a the collaborative translation platform CrowdIn to facilitate community translations. Through their generous open source program, we're able to use their platform free of charge, and we greatly appreciate their support. +Want to help translate? We'd really appreciate your contributions! Ink/Stitch uses a the collaborative translation platform Crowdin to facilitate community translations. Through their generous open source program, we're able to use their platform free of charge, and we greatly appreciate their support. -To start translating, visit our project page on CrowdIn. It's easy to sign in using your GitHub account. Pick a language and start suggesting translations! +To start translating, visit our project page on Crowdin. It's easy to sign in using your GitHub account. Pick a language and start suggesting translations! -Approved contributors can accept your translations, which causes them to be submitted to this GitHub repository as a pull request. If you'd like to become an approver, please ping [**@lexelby**](https://github.com/lexelby) or another approved contributor, or email **inkstitch-l10n** at **lex** dot **gd**. +Approved contributors can accept your translations, which causes them to be committed to this repository within 24 hours. If you'd like to become an approver, please ping [**@lexelby**](https://github.com/lexelby) or another approved contributor, or email **inkstitch-l10n** at **lex** dot **gd**. -**Please note that our [code of conduct](CODE_OF_CONDUCT.md) also covers contributions and interactions on our CrowdIn page.** +**Please note that our [code of conduct](CODE_OF_CONDUCT.md) also covers contributions and interactions on our Crowdin page.** Continuous Translation ---------------------- -When new code is added to ink/stitch, user-facing text can change and new messages can be added. CrowdIn picks these changes up automatically and makes the new messages available to translators. +When new code is added to Ink/Stitch, user-facing text can change and new messages can be added. These changes will be uploaded to Crowdin within 24 hours and made available for contributors to translate. -When CrowdIn creates a pull request, our [Travis-CI](http://travis-ci.org) integration (also generously provided for free!) picks up the new translations and builds a new version of ink/stitch as a development release. Once Travis-CI finishes building, the new version is posted to our releases page [here](https://github.com/lexelby/inkstitch/releases/tag/dev-build-l10n), and you can install it and make sure everything looks right before we merge. +Sometimes, it's necessary to see how your translated text looks in Ink/Stitch. In order to do this, follow these steps: + +1. Wait up to 24 hours until your new translations are committed to Ink/Stitch ([example](https://github.com/inkstitch/inkstitch/commit/96c319f870f7da5370ac4f3378f2cf6de0e0ccde)). +2. Make a new branch by following [these instructions](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/). +3. Visit the Travis CI project page for Ink/Stitch [here](https://travis-ci.org/inkstitch/inkstitch). +4. From the menu in the upper right, choose "Trigger build". +5. Choose your branch from the list. +6. Click "trigger custom build". +7. Once your build finishes, it will be posted to our [releases page](https://github.com/inkstitch/inkstitch/releases). + +In order to do the above steps, you'll need to be added as a collaborator on this repository. You can ping [**@lexelby**](https://github.com/lexelby) or email **inkstitch-l10n** at **lex** dot **gd** and we'll get you set up.