Improve documentation (#190)

* fix grammar

docs/actions-and-gestures.md

@@ -5,7 +5,7 @@
 # Actions and Gestures
 
 µLauncher's central mechanism for accessing important functionality quickly
-is to bind actions (e.g. launching an app) to gestures (e.g. swiping up).
+is to bind actions (e.g., launching an app) to gestures (e.g., swiping up).
 These bindings can be configured in µLauncher Settings > ACTIONS.
 
 
@@ -32,7 +32,7 @@ These bindings can be configured in µLauncher Settings > ACTIONS.
 
 - Tap then swipe up, down, left, or right
 
-    To execute these gesture consistently, it is helpful to think of them as double taps,
+    To execute these gestures consistently, it is helpful to think of them as double taps,
     where the finger stays on the screen after the second tap and then does a swipe.
     The swipe must start very shortly after the tap ended.
 
@@ -62,14 +62,14 @@ To any of the available gestures, one of the following actions can be bound:
     If private space is set up, an icon to (un)lock it is shown on the top right.
 - Open µLauncher's settings
 - Toggle private space lock
-- Lock the screen: This allows to lock the screen.
+- Lock the screen: This allows you to lock the screen.
-    There are two mechanisms by which the screen can be locked, accessibility service and device admin.
+    There are two mechanisms by which the screen can be locked: accessibility service and device admin.
 - Toggle the flashlight
-- Raise, lower or adjust volume
+- Raise, lower, or adjust volume
 - Play or pause media playback
 - Skip to previous or next audio track
 - Open notifications panel: Might be useful if the top of your screen is broken.
 - Open quick settings panel: Why swipe down twice?
-- Open [recent apps](https://developer.android.com/guide/components/activities/recents): Requires accessibility service. Can be used as a workaround for a Android bug.
+- Open [recent apps](https://developer.android.com/guide/components/activities/recents): Requires accessibility service. It can be used as a workaround for an Android bug.
 - Launch another home screen: Allows using another installed home screen temporarily.
-- Do nothing: Just prevents showing the message saying that no action is bound to this gesture.
+- Do nothing: Simply prevents showing the message that no action is bound to this gesture.

docs/alternatives.md

@@ -8,7 +8,7 @@ This is a comparison of open-source home screens for Android.
 
 **Inclusion criteria:** Apps in this list must be [open source](https://opensource.org/licenses) and maintained
 
-<!-- New contributers, please reference https://www.markdownguide.org/basic-syntax/ -->
+<!-- New contributors, please reference https://www.markdownguide.org/basic-syntax/ -->
 
 <!-- TEMPLATE
 
@@ -141,12 +141,12 @@ Seems to be a regular (grid of apps) launcher.
 
 ---
 
-## Search based
+## Search-Based
 
 ### Aster Launcher
 
 > **Abandoned**
-
+> 
 **License:** `GPL-3.0`  
 [Repository](https://github.com/neophtex/AsterLauncher) | [F-Droid](https://f-droid.org/en/packages/com.series.aster.launcher/)
 
@@ -197,7 +197,7 @@ Seems to be a regular (grid of apps) launcher.
 **License:** `GPL-3.0`  
 [Repository](https://github.com/iamrasel/lunar-launcher) | [F-Droid](https://f-droid.org/en/packages/rasel.lunar.launcher/)
 
-Even natively supports RSS feeds to homescreen?
+Even natively supports RSS feeds to the homescreen?
 
 **Main mode of interaction:** `alphabet scroller`
 
@@ -262,7 +262,7 @@ Extremely minimal launcher with lots of forks.
 
 :white_check_mark: Search:  `apps` `contacts` `web` `maps` `playstore` `youtube`  
 :white_check_mark: Search history  
-:white_check_mark:Customizable gestures: `tap` `double tap` `swipe up` `swipe left` `swipe right` `swipe down on left` `swipe down on right`  
+:white_check_mark: Customizable gestures: `tap` `double tap` `swipe up` `swipe left` `swipe right` `swipe down on left` `swipe down on right`  
 :x: Folders  
 :white_check_mark: Tags  
 :white_check_mark: Rename apps  
@@ -301,7 +301,7 @@ Similar to OLauncher?
 
 ---
 
-## Directory based
+## Directory-Based
 
 ### folder launcher
 
@@ -337,7 +337,7 @@ Similar to OLauncher?
 #### Features:
 
 :warning: Search:  `apps` `contacts: buggy/broken`  
-:white_check_mark: Search history `shows recently launched apps`  
+:white_check_mark: Search history: `shows recently launched apps`  
 :x: Customizable gestures  
 :warning: Folders `prebuilt` `not customizable`  
 :x: Tags  
@@ -351,7 +351,7 @@ Similar to OLauncher?
 
 ---
 
-## Gesture based
+## Gesture-Based
 
 ### Pie Launcher
 

docs/app-drawer.md

@@ -10,14 +10,14 @@ Besides regular apps, app drawers also show [pinned shortcuts](https://developer
 μLauncher treats apps and shortcuts in the same way.
 
 The idea of the app drawer is to search for apps using the keyboard.
-By default[^2] an app is launched automatically once it is the only app matching the query.
+By default[^2], an app is launched automatically once it is the only app matching the query.
-This can be prevented by typing space.
+This can be prevented by typing a space.
-Usually only two or three characters are needed which is much faster than scrolling to find an app.
+Usually, only two or three characters are needed, which is much faster than scrolling to find an app.
 
-[^1]: A pinned shortcut is created for example when pinning a website to the home screen.
+[^1]: A pinned shortcut is created, for example, when pinning a website to the home screen.
 [^2]: There are [several settings](/docs/settings/#functionality) available to modify the behavior.
 
-When long clicking an app, additional options are shown:
+When long-pressing an app, additional options are shown:
 * Rename the app
 * Add to / remove from Favorites: Adds the app to the [Favorite Apps](#favorite-apps) list or removes it from there.
 * Hide / Show: This hides the app from all drawers (except from [Hidden Apps](#hidden-apps)) or makes it visible again if it was hidden.
@@ -27,28 +27,26 @@ When long clicking an app, additional options are shown:
 ## All Apps
 
 This lists all apps except hidden apps.
-By default it is bound to `Swipe up`.
+By default, it is bound to `Swipe up`.
 
 ## Favorite Apps
 
 Only shows favorite apps.
-Pressing the star icon on the bottom right of any app drawer toggles whether
+Pressing the star icon on the bottom right of any app drawer toggles whether only favorite apps should be shown.
-only favorite apps should be shown.
+Additionally, the `Favorite Apps` action can be used to launch this drawer directly.
-Additionally the `Favorite Apps` action can be used to launch this drawer directly.
+By default, it is bound to `Swipe up (left edge)`.
-By default it is bound to `Swipe up (left edge)`.
 
 ## Private Space
 
 When [private space](/docs/profiles/#private-space) is available, this drawer
 shows only apps from the private space.
 It can be opened using the `Private Space` action.
-If the private space is locked, instead of showing the list the unlock dialog is shown.
+If the private space is locked, instead of showing the list, the unlock dialog is shown.
 
-By default, apps from the private space are shown in All Apps as well,
+By default, apps from the private space are shown in All Apps as well; however, this is [configurable](/docs/settings/#hide-private-space-from-app-list).
-however this is [configurable](/docs/settings/#hide-private-space-from-app-list).
 
 ## Hidden Apps
 
 This list shows hidden apps.
 It is only accessible through the settings.
-The feature is intended to be used only for apps which are not needed at all but [can not be uninstalled](https://en.wikipedia.org/wiki/Software_bloat#Bloatware).
+The feature is intended to be used only for apps that are not needed at all but [can not be uninstalled](https://en.wikipedia.org/wiki/Software_bloat#Bloatware).

docs/build.md

@@ -17,7 +17,7 @@ cd Launcher
 ./gradlew assembleDefaultRelease
 ```
 
-This will create an apk file at `app/build/outputs/apk/default/release/app-default-release-unsigned.apk`.
+This will create an APK file at `app/build/outputs/apk/default/release/app-default-release-unsigned.apk`.
 
 Note that you need to sign it:
 
@@ -50,5 +50,5 @@ The [CI pipeline](https://github.com/jrpie/Launcher/actions) automatically creat
 
 {{% hint warning %}}
 Note: These builds are not signed.
-They are in built in debug mode and only suitable for testing.
+They are built in debug mode and are only suitable for testing.
 {{% /hint %}}

docs/changes-fork.md

@@ -8,12 +8,12 @@ title = 'Differences to the original Launcher'
 Here is an incomplete list of changes:
 <!--The last commit of the original project is [340ee731](https://github.com/jrpie/launcher/commit/340ee7315293b028c060638e058516435bca296a)
 The first commit of µLauncher is [cc2e7710](https://github.com/jrpie/launcher/commit/cc2e7710c824549c367d97a81a1646d27c6c8993),
-which at the time was still intended as a patch for launcher.
+which at the time was still intended as a patch for the launcher.
 The decision to create a hard fork was made two years later.-->
 
 - Additional gestures:
   - Back
-  - V,Λ,<,>
+  - V, Λ, <, >
   - Edge gestures: There is a setting to allow distinguishing swiping at the edges of the screen from swiping in the center.
 
 - Compatible with [work profile](https://www.android.com/enterprise/work-profile/), so apps like [Shelter](https://gitea.angry.im/PeterCxy/Shelter) can be used.
@@ -35,21 +35,21 @@ The decision to create a hard fork was made two years later.-->
 - This app uses the system wallpaper instead of a custom solution.
 - The font has been changed to [Hack][hack-font], other fonts can be selected.
 - Font Awesome Icons were replaced by Material icons.
-- The gear button on the home screen was removed. A smaller button is show at the top right when necessary.
+- The gear button on the home screen was removed. A smaller button is shown at the top right when necessary.
 
 ## Search
 
-- The search algorithm was modified to prefer matches at the beginning of the app name, i.e. when searching for `"te"`, `"termux"` is sorted before `"notes"`.
+- The search algorithm was modified to prefer matches at the beginning of the app name, i.e., when searching for `"te"`, `"termux"` is sorted before `"notes"`.
 - The search bar was moved to the bottom of the screen.
 
 ## Technical
 
 - Improved gesture detection.
-- Different apps set as default.
+- Different apps are set as the defaults.
 - Package name was changed to `de.jrpie.android.launcher` to avoid clashing with the original app.
-- Dropped support for API < 21 (i.e. pre Lollypop)
+- Dropped support for API < 21 (i.e., pre Lollypop).
-- Fixed some bugs
+- Fixed some bugs.
-- Some refactoring
+- Some refactoring.
 
 The complete list of changes can be viewed [here](https://github.com/jrpie/launcher/compare/340ee731...master).
 

docs/contributing.md

@@ -8,9 +8,9 @@
 There are several ways to contribute to this app:
 * You can add or improve [translations][toolate].
      <br><img src="https://toolate.othing.xyz/widget/jrpie-launcher/launcher/horizontal-auto.svg" alt="translation status">
-* If you found a bug or have an idea for a new feature you can [join the chat][chat] or open an [issue][issues].
+* If you found a bug or have an idea for a new feature, you can [join the chat][chat] or open an [issue][issues].
 
-    > Please note that I work on this project in my free time. Thus I might not respond immediately and not all ideas will be implemented.
+    > Please note that I work on this project in my free time. Thus, I might not respond immediately, and not all ideas will be implemented.
 
 * You can implement a new feature yourself:
   - Create a [fork][fork] of this repository.
@@ -18,7 +18,7 @@ There are several ways to contribute to this app:
   - Open a new pull request.
 
 
-See [here](/docs/build) for instructions how to build this project.
+See [here](/docs/build) for instructions on how to build this project.
 The [CI pipeline](https://github.com/jrpie/Launcher/actions) automatically creates debug builds.
 
 

docs/settings.md

@@ -7,14 +7,14 @@
 Tweaks and customizations can be made from within the settings page.
 The settings can be opened by binding the Settings action to a gesture (this is especially useful when configuring μLauncher for the first time) or from the settings icon in the app drawer.[^1]
 
-[^1]: i.e. the 'All Apps', 'Favorite Apps' and 'Private Space' views.
+[^1]: i.e., the 'All Apps', 'Favorite Apps', and 'Private Space' views.
 
 ## Appearance
 
 ### Choose a wallpaper
 
-This triggers Android's mechanism to change the wallpaper using a photos app, file explorer, or native wallpaper setting app.
+This triggers Android's mechanism to change the wallpaper using a photo app, file explorer, or native wallpaper setting app.
-µLauncher uses the system-wide wallpaper, i.e. this change also affects other launchers.
+µLauncher uses the system-wide wallpaper, i.e., this change also affects other launchers.
 
 ### Font (in-app font)
 
@@ -28,7 +28,7 @@ Set the font used within the app settings. This setting does not affect the date
 
 **type:** `toggle`
 
-### Background (app list and setting)
+### Background (app list and settings)
 
 Defines which background should be used in app drawers, settings, etc.
 to increase legibility.
@@ -37,7 +37,7 @@ to increase legibility.
 * `Blur` tries to blur the wallpaper. This is not possible on all devices. Some older devices don't support the operation. Also blur can be temporarily unavailable when the device is in power saving mode. In these case, `Dim` is used as a fallback.
 * `Solid` sets the background to a solid color (depending on the color theme). For the light theme only this option is available.
 
-On the home screen and on widget panels the wallpaper is always shown unmodified.
+On the home screen and widget panels, the wallpaper is always shown unmodified.
 
 **type:** `dropdown`
 
@@ -51,7 +51,7 @@ Remove coloring from all app icons. Can help decrease visual stimulus when enabl
 
 ## Date & Time
 
-These settings effect the clock shown on the home screen (or on widget panels).
+These settings affect the clock shown on the home screen (or on widget panels).
 If the clock is removed, the settings are not used.
 
 ### Font (home screen)
@@ -66,12 +66,12 @@ Set the home screen font for date and time. This setting does not affect the fon
 
 Set the color for the home screen date and time.
 
-Accepts an 6 digit RGB or or 8 digit ARGB color code characters.[^2]
+Accepts a 6-digit RGB or 8-digit ARGB color code characters.[^2]
-Note that on Android the ARGB color format is used, i.e. the alpha component is specified first.
+Note that on Android, the ARGB color format is used, i.e., the alpha component is specified first.
 This differs from the more common RGBA, which is used in web development.
 
 
-[^2]: More precisely, everything that is vaild input for [parseColor](https://developer.android.com/reference/android/graphics/Color#parseColor(java.lang.String)) can be used.
+[^2]: More precisely, everything that is valid input for [parseColor](https://developer.android.com/reference/android/graphics/Color#parseColor(java.lang.String)) can be used.
 
 
 **type:** `ARGB`
@@ -110,7 +110,7 @@ Place the current time above the current date on the home screen.
 
 ### Launch search results
 
-Launches any app that matches user keyboard input when no other apps match.
+Launches any app that matches the user's keyboard input when no other apps match.
 
 As you type inside the app drawer, the app narrows down the list of apps shown based on the app title matching your text input.
 With the 'launch search results' setting, once only one matching app remains, it is launched immediately.
@@ -156,7 +156,7 @@ Change how large a margin is used for detecting edge gestures. Shows the edge ma
 
 ### Choose method for locking the screen
 
-There are two methods to lock the screen and unfortunately both have downsides.
+There are two methods to lock the screen, and unfortunately, both have downsides.
 
 1. **`Device Admin`**
 
@@ -166,7 +166,7 @@ There are two methods to lock the screen and unfortunately both have downsides.
 
     - Requires excessive privileges.
     - μLauncher will use those privileges *only* for locking the screen.
-    - As a rule of thumb, it is [not recommended](https://android.stackexchange.com/questions/248171/is-it-safe-to-give-accessibility-permission-to-an-app) to grant access to accessibility services on a random app. Always review the [source code](https://github.com/jrpie/Launcher) before granting accessibility permissions so you familiarize yourself with what the code might do.
+    - As a rule of thumb, it is [not recommended](https://android.stackexchange.com/questions/248171/is-it-safe-to-give-accessibility-permission-to-an-app) to grant access to accessibility services to a random app. Always review the [source code](https://github.com/jrpie/Launcher) before granting accessibility permissions so you can familiarize yourself with what the code might do.
     - On some devices, the start-up PIN will no longer be used for encrypting data after activating an accessibility service.
     - This can be [reactivated](https://issuetracker.google.com/issues/37010136#comment36) afterwards.
 
@@ -184,21 +184,21 @@ Open an app drawer containing only hidden apps.
 
 Remove certain apps from the app drawer if they are already accessible via a gesture.
 
-Reduces redundancy and tidies up app drawer.
+Reduces redundancy and tidies up the app drawer.
 
 **type:** `toggle`
 
 ### Hide paused apps
 
 Remove paused apps from the app drawer.
-For example an app belonging to the work profile is paused when the work profile is inactive.
+For example, an app belonging to the work profile is paused when the work profile is inactive.
 
 **type:** `toggle`
 
 ### Hide private space from app list
 
-Remove private space from app drawer.
+Remove private space from the app drawer.
-Private space apps can be accessed using a separate app drawer which can be opened with the Private Space action.
+Private space apps can be accessed using a separate app drawer, which can be opened with the Private Space action.
 
 **type:** `toggle`
 
@@ -240,6 +240,6 @@ Remove the top status bar from the home screen.
 
 ### Hide navigation bar
 
-Remove the navigation bar from the home screen. Enabling this setting may make it difficult to use the device if gestures are not setup properly.
+Remove the navigation bar from the home screen. Enabling this setting may make it difficult to use the device if gestures are not set up properly.
 
 **type:** `toggle`

docs/widgets.md

@@ -7,7 +7,7 @@
 
 μLauncher allows to add [app widgets](https://developer.android.com/develop/ui/views/appwidgets/overview) to the home screen and to widget panels.
 
-Widgets can be added, moved, removed and configured in `Settings > Manage Widgets`.
+Widgets can be added, moved, removed, and configured in `Settings > Manage Widgets`.
 
 It is configurable whether or not interaction with a widget should be enabled.
 
@@ -17,7 +17,7 @@ However, μLauncher [gestures](/docs/actions-and-gestures/) can not be execute
 * If interaction is disabled, the widget does not respond to any touch events.
     This is recommended when using a widget only to display information.
 
-μLauncher's clock behaves similar as an app widget and can be managed in the same way.[^1]
+μLauncher's clock behaves similarly to an app widget and can be managed in the same way.[^1]
 
 [^1]: However, it is technically not an app widget and cannot be used with other launchers.