From 0fd756853611bd6df0bf6e3b7eca4919a8b457a3 Mon Sep 17 00:00:00 2001 From: Seb3thehacker Date: Mon, 26 Oct 2026 12:51:24 -0700 Subject: [PATCH] docs: translations happen on Weblate, with a badge in the README and how translators sign the CLA --- CLA.md | 3 +++ CONTRIBUTING.md | 13 +++++++++++++ README.md | 5 +++++ 3 files changed, 21 insertions(+) diff --git a/CLA.md b/CLA.md index 9c7c7c8..c6251ac 100644 --- a/CLA.md +++ b/CLA.md @@ -88,6 +88,9 @@ We are not required to use or include any Contribution. Most contributors sign on GitHub: the CLA Assistant bot comments on your first pull request, and you sign there with one click. Your GitHub account then serves as your signature. +Translators sign on Weblate: it shows this agreement before your first translation, and +accepting it there serves as your signature. + To sign by hand instead, fill in the following and send it to us on Matrix. The address is on the [Seb3thehacker GitHub profile](https://github.com/Seb3thehacker). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ce0727..89a7b08 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,19 @@ branch on `experimental`, and open your pull request against it. - Gearslip asks for no adb, root, or Shizuku. A feature must work with ordinary Android permissions and on-device consent dialogs. +## Translating + +Translations happen on [Weblate](https://hosted.weblate.org/engage/gearslip/), not in pull +requests. Pick your language, or start a new one, and translate in the browser. Weblate +sends the finished work to this repository as a pull request. + +Keep the tone of the English: short, plain, and friendly. Leave placeholders such as `%1$s` +and `%1$d` in place; Gearslip fills them with names and numbers. Untranslated strings show +in English, so a partial translation is still useful. + +Before your first translation, Weblate asks you to accept the +[Contributor License Agreement](CLA.md). That counts as signing it. + ## Writing Text that users read, such as screens, release notes, and docs, follows Strunk's diff --git a/README.md b/README.md index df6d10b..8517674 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ An Android Auto alternative built for everyone. [Get it on Obtainium](https://apps.obtainium.imranr.dev/redirect?r=obtainium://add/https://github.com/twinksoftware/gearslip) +[![Translation status](https://hosted.weblate.org/widget/gearslip/app/svg-badge.svg)](https://hosted.weblate.org/engage/gearslip/) + Questions, ideas? [Join the discussion on Matrix](https://matrix.to/#/!mf0_mgBd5KqKpc9FfX_wHp1jFCcwAtPrndIn_oGIyMk?via=matrix.org). @@ -153,6 +155,9 @@ Bug reports from real cars help most, and pull requests are welcome. [CONTRIBUTING.md](CONTRIBUTING.md) explains what to put in a report, which branch to work on, and the one-time agreement you sign before your first pull request merges. +To help translate Gearslip into your language, join +[Gearslip on Weblate](https://hosted.weblate.org/engage/gearslip/). No coding needed. + ## Building ```