Rebrand to TalkBack FOSS

Signed-off-by: Patryk Miś <[email protected]>

Author: PatrykMis

README.md

@@ -1,20 +1,60 @@
-# Introduction
+# TalkBack-FOSS
 
-This repository contains source code for Google's TalkBack, which is a screen
-reader for blind and visually-impaired users of Android. For usage instructions,
-see
-[TalkBack User Guide](https://support.google.com/accessibility/android/answer/6283677?hl=en).
+## Introduction
 
-### How to Build
+Welcome to TalkBack-FOSS, the FOSS-friendly fork of Google's TalkBack – a screen reader designed for Android users who are blind or visually impaired.
+This repository prioritizes open-source principles, ensuring freedom, privacy and accessibility for all.
 
-To build TalkBack, run ./build.sh, which will produce an apk file.
+For detailed usage instructions, consult the [official TalkBack User Guide](https://support.google.com/accessibility/android/answer/6283677).
 
-### How to Install
+## Support
 
-Install the apk onto your Android device in the usual manner using adb.
+Join the conversation on Matrix: [#talkback-foss:matrix.org](https://matrix.to/#/#talkback-foss:matrix.org).
 
-### How to Run
+Feel free to contribute, report issues through our [issue tracker](https://github.com/talkback-foss-team/talkback-foss/), or discuss improvements via our [GitHub discussions](https://github.com/talkback-foss-team/talkback-foss/discussions/).
 
-With the apk now installed on the device, the TalkBack service should now be
-present under Settings -> Accessibility, and will be off by default. To turn it
-on, toggle the switch preference to the on position.
+## Changes from upstream
+
+All changes are documented in the commits log. Below are the most important ones:
+
+* Removed unnecessary Google closed-source dependencies and permissions (credits to [Tad](https://github.com/SkewedZeppelin) from [DivestOS](https://github.com/Divested-Mobile/talkback/) project)
+* Various translations and typo fixes
+* added Gradle Wrapper to simplify build process on various systems
+* various improvements from [GrapheneOS](https://github.com/GrapheneOS/talkback) project by [Daniel Micay](https://github.com/thestinger)
+* updated dependencies which may fix bugs and potential security issues
+* Do not show onboarding when lock task mode is enabled ([PR #77](https://github.com/talkback-foss-team/talkback-foss/pull/77) by [@marukami](https://github.com/marukami))
+* Expanded instructions in the readme
+
+There is also an issue tracker where various issues and improvements can be discussed. Unfortunately, the upstream code is not being updated too often.
+
+## How to Build
+
+**NOTE:** This version won't build under Windows due to brltty incompatibilities. Patches are welcome. Use a GNU/Linux distribution, WSL2, or GitHub CI.
+
+To build TalkBack, Issue the following command:
+
+```bash
+./gradlew build
+```
+
+Don't forget to sign the release APK if you plan to use it.
+
+## How to Install and run
+
+1. Install the APK on your Android device using the standard adb method.
+2. With the APK installed, the TalkBack FOSS service should now appear under Settings -> Accessibility. By default, it will be turned off. Toggle the switch preference to the "on" position to activate it.
+
+Alternatively, you can enable TalkBack via ADB:
+
+```bash
+adb shell settings put secure enabled_accessibility_services app.talkbackfoss/com.google.android.marvin.talkback.TalkBackService
+```
+
+## Versioning
+
+Versions follow the format "v$UPSTREAM_VERSION_WITH_BUILD_NUMBER-$RELEASE", where:
+
+* $UPSTREAM is the public, visible version of upstream release.
+* $RELEASE is a letter `f` followed by this fork's release number.
+
+For example, "v12.1.0.397273158-f01" signifies the first release based on upstream version "12.1.0.397273158".

braille/brailleime/src/phone/res/values-af/strings.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">
-  <string name="braille_ime_service_name">TalkBack se braille-sleutelbord</string>
+  <string name="braille_ime_service_name">TalkBack FOSS se braille-sleutelbord</string>
   <string name="braille_ime_bd_mode_name">Brailleskerm-invoer</string>
   <string name="switch_to_screen_away_announcement">Skermwegmodus</string>
   <string name="switch_to_tabletop_announcement">Tafelbladmodus. Plaas jou toestel met die laaipoort na links.</string>
@@ -11,7 +11,7 @@
   <string name="switched_to_uncontracted_announcement">Het na nie-verkorte braille toe oorgeskakel</string>
   <string name="braille_ime_displayed_name">braille-sleutelbord</string>
   <string name="multiple_languages_braille_ime_displayed_name">braille-sleutelbord, %s</string>
-  <string name="input_view_caption">TalkBack se braille-sleutelbord – besoek g.co/help/braille vir hulp</string>
+  <string name="input_view_caption">TalkBack FOSS se braille-sleutelbord – besoek g.co/help/braille vir hulp</string>
   <string name="perform_action_next">Volgende</string>
   <string name="perform_action_submitting">Dien tans teks in</string>
   <string name="calibration_step1_hold_left_or_right_finger_announcement">Dateer tans puntposisie op. Kom ons teken eers die punte op jou %s aan.</string>
@@ -137,17 +137,17 @@
   <string name="bk_gesture_undo_spelling_suggestion">• Ontdoen voorstel: Swiep links met 2 vingers</string>
   <string name="not_enough_touch_points_dialog_title">Jou toestel steun nie braille-sleutelbord nie</string>
   <string name="not_enough_touch_points_dialog_message">Jou toestel steun nie genoeg raakpunte nie. Kontak jou toestelvervaardiger vir meer inligting.</string>
-  <string name="talkback_off_dialog_title">Skakel TalkBack aan om braille-sleutelbord te gebruik</string>
+  <string name="talkback_off_dialog_title">Skakel TalkBack FOSS aan om braille-sleutelbord te gebruik</string>
   <string name="talkback_off_dialog_positive_button">Skakel in toeganklikheidinstellings aan</string>
-  <string name="talkback_suspend_dialog_title">Hervat TalkBack om braillesleutelbord te gebruik</string>
-  <string name="talkback_off_or_suspend_dialog_message">Wanneer Talkback aan is, kan jy op jou skerm tik om braillesimbole in te voer.</string>
+  <string name="talkback_suspend_dialog_title">Hervat TalkBack FOSS om braillesleutelbord te gebruik</string>
+  <string name="talkback_off_or_suspend_dialog_message">Wanneer TalkBack FOSS aan is, kan jy op jou skerm tik om braillesimbole in te voer.</string>
   <string name="next_keyboard">Volgende sleutelbord</string>
   <string name="braille_tutorial_title">Braille-sleutelbordtutoriaal</string>
-  <string name="tutorial_intro_description">Met die braillesleutelbord kan jy op jou skerm tik om 6-knoppiebraille in te voer.\n\nJy gebruik tans Verenigde Engelse Braille. Gaan na TalkBack-instellings om jou tiktaal te wissel.\n\nJy moet jou foon anders vashou en gebruik om braille te tik.</string>
+  <string name="tutorial_intro_description">Met die braillesleutelbord kan jy op jou skerm tik om 6-knoppiebraille in te voer.\n\nJy gebruik tans Verenigde Engelse Braille. Gaan na TalkBack FOSS-instellings om jou tiktaal te wissel.\n\nJy moet jou foon anders vashou en gebruik om braille te tik.</string>
   <string name="next_step">Volgende</string>
   <string name="leave_keyboard">Verlaat braille-sleutelbord</string>
-  <string name="hold_six_fingers_description">Jy sal nie gewone TalkBack-gebare in the braillesleutelbord kan gebruik nie.\n\nOm aan die gang te kom, kan ons die posisie opstel van die 6 braillepunte wanneer jy tik.</string>
-  <string name="rotate_orientation_description_1">Jy sal van nou af nie meer gewone TalkBack-gebare kan gebruik nie. TalkBack is nie beskikbaar terwyl jy die braille-sleutelbord gebruik nie.</string>
+  <string name="hold_six_fingers_description">Jy sal nie gewone TalkBack FOSS-gebare in the braillesleutelbord kan gebruik nie.\n\nOm aan die gang te kom, kan ons die posisie opstel van die 6 braillepunte wanneer jy tik.</string>
+  <string name="rotate_orientation_description_1">Jy sal van nou af nie meer gewone TalkBack FOSS-gebare kan gebruik nie. TalkBack FOSS is nie beskikbaar terwyl jy die braille-sleutelbord gebruik nie.</string>
   <string name="rotate_orientation_description_2">Om te begin, moet jy jou foon só vashou met die skerm wat weg van jou af wys.</string>
   <string name="tap_to_continue">Dubbeltik enige plek om voort te gaan</string>
   <string name="instruction_type_letter_a">Tik op punt 1 met jou linkerwysvinger om die letter \"A\" te tik</string>
@@ -165,7 +165,7 @@
   <string name="result_swipe_down">SKERMPYLTJIE VORENTOE GESKUIF</string>
   <string name="result_swipe_down_2_fingers">VERSTEEK SLEUTELBORD</string>
   <string name="result_swipe_down_3_fingers">VOLGENDE SLEUTELBORD</string>
-  <string name="rotate_orientation_announcement">Jy sal van nou af nie meer gewone TalkBack-gebare kan gebruik nie. TalkBack is nie beskikbaar terwyl jy die braillesleutelbord gebruik nie.\n\n%1$s</string>
+  <string name="rotate_orientation_announcement">Jy sal van nou af nie meer gewone TalkBack FOSS-gebare kan gebruik nie. TalkBack FOSS is nie beskikbaar terwyl jy die braillesleutelbord gebruik nie.\n\n%1$s</string>
   <string name="rotate_orientation_inactive_announcement">Draai eers jou foon sodat die skerm weg van jou af wys.\n\nDraai die foon dan horisontaal sodat dit in landskapposisie is. Jou hande moet die kort kante van die foon vashou. Jou regterhand moet die kant met die USB-poort vashou. Rus jou 3 middelvingers op die skerm en gebruik jou pinkie en duim om die foon vas te hou.\n\nDubbeltik wanneer jy gereed is op die skerm om voort te gaan.\n\nSwiep met 3 vingers af na die grond toe om die braillesleutelbord te verlaat. Jy sal dan na jou oorspronklike sleutelbord toe terugkeer.</string>
   <string name="rotate_orientation_continue_announcement">Jou foon is in \'n vertikale posisie. Om voort te gaan, draai jou foon horisontaal sodat die lang kant onder is. Draai die skerm dan só dat dit weg van jou af wys. Dubbeltik wanneer jy gereed is op die skerm om voort te gaan.</string>
   <string name="type_letter_a_announcement">Hou die skerm só vas dat dit weg van jou af wys. Hou jou foon in albei hande vas, op die kort kante van die foon, sodat die middelste 3 vingers van elke hand die skerm kan raak.\n\nJou linkerwysvinger moet op punt 1 wees. Tik nou op punt 1 om die letter “A” te tik.</string>
@@ -181,7 +181,7 @@
   <string name="swipe_down_3_fingers_announcement">Swiep af met 3 vingers om na jou ander sleutelbord toe oor te skakel. Probeer dit nou.</string>
   <string name="swipe_down_3_fingers_completed_announcement">Volgende sleutelbord. Dit sal gewoonlik na die volgende sleutelbord toe oorskakel. Hierdie keer sal jy in die braille-sleutelbord bly omdat jy steeds in die tutoriaal is.</string>
   <string name="swipe_up_3_fingers_announcement">Jy kan ook in tafelbladmodus tik deur jou foon plat op \'n tafel te plaas. Om die tutoriaal te voltooi, moet jy met 3 vingers opswiep en die \"voltooi tutoriaal\"-opsie kry</string>
-  <string name="open_context_menu_announcement">Die opsieskieslys is oop. Keer jou foon om sodat dit na jou toe wys en hou dit normaal vas. Jy kan nou die gewone TalkBack-gebare gebruik om te navigeer. Swiep regs om meer opsies te sien.</string>
+  <string name="open_context_menu_announcement">Die opsieskieslys is oop. Keer jou foon om sodat dit na jou toe wys en hou dit normaal vas. Jy kan nou die gewone TalkBack FOSS-gebare gebruik om te navigeer. Swiep regs om meer opsies te sien.</string>
   <string name="hold_six_fingers_announcement">%s\nSit jou toestel plat op \'n tafel neer. Raak en hou dan die skerm met die middelste 3 vingers van elke hand in \'n posisie waarin dit vir jou gemaklik is om te tik.</string>
   <string name="hold_six_fingers_inactive_announcement">Sit jou toestel plat op \'n tafel neer. Raak en hou dan die skerm met die middelste 3 vingers van elke hand in \'n posisie waarin dit vir jou gemaklik is om te tik.</string>
   <string name="finish_tutorial_announcement">Wys tans braillesleutelbord. Draai jou foon sodat die skerm weg van jou af wys. Draai die foon dan horisontaal sodat dit in landskapposisie is. Begin dan tik.</string>