From 4363ddb2be23179907ed88ffc7d7701cfe358b7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patryk=20Mi=C5=9B?= Date: Wed, 20 Dec 2023 19:52:40 +0100 Subject: [PATCH] Refine README.md for clarity and completeness MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Patryk Miś --- README.md | 48 +++++++++++++++++++++++++++--------------------- 1 file changed, 27 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index c629b44da..07aa1e48f 100644 --- a/README.md +++ b/README.md @@ -2,52 +2,58 @@ ## Introduction -This repository is the FOSS-friendly fork of 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). +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. + +For detailed usage instructions, consult the [official TalkBack User Guide](https://support.google.com/accessibility/android/answer/6283677). ## Support -Matrix: [#talkback-foss:matrix.org](https://matrix.to/#/#talkback-foss:matrix.org) +Join the conversation on Matrix: [#talkback-foss:matrix.org](https://matrix.to/#/#talkback-foss:matrix.org). + +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/). ## Changes from upstream -All changes are in the commits log. Below are the most important ones: +All changes are documented in the commits log. Below are the most important ones: -* Removed unnecessary Google dependencies and permissions (credits to [Tad](https://github.com/SkewedZeppelin) from [DivestOS](https://github.com/Divested-Mobile/talkback/) project) +* 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 -* Added more instructions in the readme +* 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. +**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 `./gradlew build` command. Sign the release apk first if you would like to use it. +To build TalkBack, Issue the following command: -## How to Install +```bash +./gradlew build +``` -Install the apk onto your Android device in the usual manner using adb. +Don't forget to sign the release APK if you plan to use it. -## How to Run +## How to Install and run -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. +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 do it via ADB: +Alternatively, you can enable TalkBack via ADB: -adb shell settings put secure enabled_accessibility_services app.talkbackfoss/com.google.android.marvin.talkback.TalkBackService +```bash +adb shell settings put secure enabled_accessibility_services app.talkbackfoss/com.google.android.marvin.talkback.TalkBackService +``` ## Versioning -Versions are in form "v$UPSTREAM_VERSION_WITH_BUILD_NUMBER-$RELEASE" where: +Versions follow the format "v$UPSTREAM_VERSION_WITH_BUILD_NUMBER-$RELEASE", where: -* $UPSTREAM is the public, visible version of upstream. -* $RELEASE is a letter `f` followed by this fork's release. +* $UPSTREAM is the public, visible version of upstream release. +* $RELEASE is a letter `f` followed by this fork's release number. -e.g. 12.1.0.397273158-f01 means first release based on upstream 12.1.0.397273158 version. +For example, "v12.1.0.397273158-f01" signifies the first release based on upstream version "12.1.0.397273158".