diff --git a/docs/build.md b/docs/Building-from-Source.md similarity index 76% rename from docs/build.md rename to docs/Building-from-Source.md index 75921f9..3c2ef1f 100644 --- a/docs/build.md +++ b/docs/Building-from-Source.md @@ -1,11 +1,9 @@ -# Building µLauncher +# Using the command line -## Using the command line - -Install JDK 17 and the Android Sdk. +Install JDK 17 and the Android SDK. Make sure that `JAVA_HOME` and `ANDROID_HOME` are set correctly. -``` +```bash git clone https://github.com/jrpie/Launcher cd Launcher @@ -15,7 +13,7 @@ cd Launcher 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: -``` +```bash apksigner sign --ks "$YOUR_KEYSTORE" \ --ks-key-alias "$YOUR_ALIAS" \ --ks-pass="pass:$YOUR_PASSWORD" \ @@ -28,13 +26,18 @@ apksigner sign --ks "$YOUR_KEYSTORE" \ app-default-release-unsigned.apk ``` - See [this guide](https://developer.android.com/build/building-cmdline) for further instructions. -## Using Android Studio +# Using Android Studio + Install [Android Studio](https://developer.android.com/studio), import this project and build it. See [this guide](https://developer.android.com/studio/run) -for further instructions. +for further instructions. How to + +# CI Pipeline + +The [CI pipeline](https://github.com/jrpie/Launcher/actions) automatically creates debug builds. +> Note: These builds are *not* signed. diff --git a/docs/launcher.md b/docs/Changes-from-Finns-Launcher.md similarity index 100% rename from docs/launcher.md rename to docs/Changes-from-Finns-Launcher.md diff --git a/docs/Contributing.md b/docs/Contributing.md new file mode 100644 index 0000000..bd56a7a --- /dev/null +++ b/docs/Contributing.md @@ -0,0 +1,10 @@ +# Ways to contribute + +- Found a **bug** or have an idea for a **new feature**? [Join the chat](https://s.jrpie.de/launcher-chat) or open an [issue](https://github.com/jrpie/Launcher/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. +- Implement a new feature yourself: + 1. [Fork](https://github.com/jrpie/launcher/fork) this repository. + 2. Create a **new branch** named *feature/\* or *fix/\* and commit your changes. + 3. Open a new pull request. +- Add or improve [translations](https://toolate.othing.xyz/projects/jrpie-launcher/). +translation status \ No newline at end of file diff --git a/docs/Gestures-and-Bindings.md b/docs/Gestures-and-Bindings.md new file mode 100644 index 0000000..d87a406 --- /dev/null +++ b/docs/Gestures-and-Bindings.md @@ -0,0 +1,47 @@ +# Available Gestures +## Swipes +- Up, down, left, or right. +- Up, down, left, or right with two fingers. +- Up or down on the left or right edge. +- Left or right on the top or bottom edge. + +## Taps +- Tap on date or time. +- Double tap. +- Long tap. + +## Tap-then-Swipes +tap then swipe up, down, left, or right + +## Complex Gestures +- Draw <, >, V, or Λ. +- Draw <, >, V, or Λ in reverse direction. + +## Hardware Buttons as Gestures +- Back button. +- Volume up or down button. + + +*** + + +# Available Bindings +Any of the above gestures can be bound to any of the following bindings. +## Launcher Bindings +- Open µLauncher settings. +- Open a list of all*, favorite, or private* apps. + +## App Bindings +- Launch an app. +- Launch another Home Screen. + +## Android / Device Bindings +- Toggle private space lock. +- Lock the screen. +- Toggle the torch (flashlight) +- Raise or lower volume. +- Skip to previous or next audio track. +- Open Notifications shade. +- Open Quick Settings shade. + +> \* excludes apps hidden by the user \ No newline at end of file diff --git a/docs/Home.md b/docs/Home.md new file mode 100644 index 0000000..8ce432c --- /dev/null +++ b/docs/Home.md @@ -0,0 +1,37 @@ +# Welcome to the μLauncher wiki! +We're thrilled you're here and confident you'll love your new Android launcher! Check out this wiki to get familiar with your new app. + +## What is μLauncher? +µLauncher is an *minimal* and *distraction-free* Android home screen that lets you launch apps using *efficient* swipe gestures and button presses. This project is a fork of [finnmglas's app Launcher](https://github.com/finnmglas/Launcher). An incomplete list of changes can be found [here](https://github.com/wassupluke/Launcher/blob/master/docs/launcher.md). + +## Where can I get μLauncher? +Get it on F-Droid +Get it on Accrescent +Get it on Obtainium +Get it on GitHub + +> You can also [get it on Google Play](https://play.google.com/store/apps/details?id=de.jrpie.android.launcher), but this is not recommend. + +## Screenshots +μLauncher Home Screen screenshot +μLauncher Settings screenshot +μLauncher All Apps list view with icons screenshot +μLauncher Favorite Apps list view with icons screenshot +μLauncher Choose App to bind to gesture screenshot +μLauncher App options card from list view with icons screenshot +μLauncher All Apps list view without icons screenshot + \ No newline at end of file diff --git a/docs/Launcher-Settings.md b/docs/Launcher-Settings.md new file mode 100644 index 0000000..ac665fa --- /dev/null +++ b/docs/Launcher-Settings.md @@ -0,0 +1,222 @@ +Tweaks and customizations can be made from within the Launcher Settings page. + +These settings let you change wallpapers, change colors and fonts, enable monochrome app icons, change the app drawer layout, and much more. + +In the following documentation, 'app drawer' will be used to refer to the 'All Apps' and 'Favorite Apps' views. + + +# Appearance + +### Choose a wallpaper +Lets you change the wallpaper using a photos app, file explorer, or native wallpaper setting app. + + +> ### Font + +Set the font used within the app settings. This setting does not affect the date/time [home screen font](https://github.com/wassupluke/Launcher/wiki/Tweaks-and-Customizations/_edit#font-1). + +**type:** `dropdown` + +**options:** `Hack`,`System default`,`Sans serif`,`Serif`,`Monospace`,`Serif monospace` + +> ### Text Shadow + +**type:** `toggle` + +> ### Background (app list and setting) + +**type:** `dropdown` + +**type:** `Transparent`,`Dim`,`Blur`,`Solid` + +> ### Monochrome app icons + +Remove coloring from all app icons. Can help decrease visual stimulus when enabled. + +**type:** `toggle` + + +# Date & Time + +> ### Font + +Set the home screen font for date and time. This setting does not affect the [app settings font](https://github.com/wassupluke/Launcher/wiki/Tweaks-and-Customizations/_edit#font). + +**type:** `dropdown` + +**options:** `Hack`,`System default`,`Sans serif`,`Serif`,`Monospace`,`Serif monospace` + +> ### Color [`[bug]`](https://github.com/jrpie/launcher/issues/151) + +Set the color for the home screen date and time. + +Accepts a HEX color code (consisting of a '#' followed by three sets of two alphanumeric (letters and numbers) characters. A fourth set of two alphanumeric characters may be added to set the transparency of the color. + +[Color wheel picker](https://rgbacolorpicker.com/color-wheel-picker) + +**type:** `HEX`,`RGBA` + +> ### Use localized date format + +Adapt the display of dates and times to the specific conventions of a particular locale or region. Different locales use different date orders (e.g., MM/DD/YYYY in the US, DD/MM/YYYY in Europe). + +**type:** `toggle` + +> ### Show time + +Show the current time on the home screen. + +**type:** `toggle` + +> ### Show seconds + +Show the current time down to the second on the home screen. + +**type:** `toggle` + +> ### Show date + +Show the current date on the home screen. + +**type:** `toggle` + +> ### Flip date and time + +Place the current time above the current date on the home screen. + +**type:** `toggle` + + +# Functionality + +> ### Launch search results + +Launches any app that matches user 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. For example, if you type, `a`, the app list narrows to any apps with a title containing the letter `a`. Continuing the example, if you then follow your `a` with the letter `m`, the list now shows only apps containing the letter combination `am` in that order. If the only app matching this combination was, for example, `Amazon`, simply typing `am` in the app drawer would immediately launch the `Amazon` app for you. + +This feature becomes more powerful when combined with [renaming](https://github.com/wassupluke/Launcher/wiki/Launcher-Settings/_edit#additional-settings) apps, effectively letting you define custom app names that could be considered 'aliases' or shortcuts. For instance, if you wanted to "bind" the keyboard input `gh` to open your `GitHub` app, you could rename `GitHub` to `GitHub gh`, `gh GitHub`, or simply `gh`. Assuming no other installed apps have the `gh` combination of letters in them, opening the app drawer and typing `gh` would immediately launch your `GitHub` app. + +Press space to temporarily disable this feature and allow text entry without prematurely launching an app. Useful when combined with the [Search the web](https://github.com/wassupluke/Launcher/wiki/Launcher-Settings/_edit#search-the-web) feature. + +**type:** `toggle` + +> ### Search the web + +Press return/enter while searching the app list to launch a web search. + +**type:** `toggle` + +> ### Start keyboard for search + +Automatically open the keyboard when the app drawer is opened. + +**type:** `toggle` + +> ### Double swipe actions + +Enable double swipe (two finger) actions as bindable gestures in launcher settings. Does not erase gesture bindings if accidentally turned off. + +**type:** `toggle` + +> ### Edge swipe actions + +Enable edge swipe (near edges of screen) actions as bindable gestures in launcher settings. Does not erase gesture bindings if accidentally turned off. + +**type:** `toggle` + +> ### Edge width + +Change how large a margin is used for detecting edge gestures. Shows the edge margin preview when using the slider. + +**type:** `slider` + +> ### Choose method for locking the screen + +There are two methods to lock the screen and unfortunately both have downsides. +1. **`Device Admin`** + - Doesn't work with unlocking by fingerprint or face recognition. +2. **`Accessibility Service`** + - 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. + - 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. + +**type:** `text buttons` + +**options:** `USE DEVICE ADMIN`,`USE ACCESSIBILITY SERVICE` + +# Apps + +> ### Hidden apps + +Open an app drawer containing only hidden apps. + +> ### Don't show apps that are bound to a gesture in the app list + +Remove certain apps from the app drawer if they are already accessible via a gesture. + +Reduces redundancy and tidies up app drawer. + +**type:** `toggle` + +> ### Hide paused apps + +Remove paused apps from the app drawer. + +**type:** `toggle` + +> ### Hide private space from app list + +Remove private space from app drawer. + +**type:** `toggle` + +> ### Layout of app list + +Change how the apps are displayed when accessing the app drawer. By `Default`, all apps in the drawer will show in a vertically-scrolled list with their app icon and title. `Text` removes the app icons, shows only app titles in the drawer as a vertically-scrolled list. `Grid` shows apps with their app icon and title in a grid layout. + +**type:** `dropdown` + +**options:** `Default`,`Text`,`Grid` + +> ### Reverse the app list + +Enable Z-A sorting of apps in the app drawer. Useful for keeping apps within easier reach from the keyboard. + +**type:** `toggle` + + +# Display + +> ### Rotate screen + +**type:** `toggle` + +> ### Keep screen on + +**type:** `toggle` + +> ### Hide status bar + +Remove the top status bar from the home screen. + +**type:** `toggle` + +> ### 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. + +**type:** `toggle` + + +# Additional Settings + +> ### App Drawer Long Press on App + +Access additional per-app details and settings. To use, open the app drawer and long press on any app. + +**type:** `dropdown` + +**options:** `App Info`,`Add to favorites`,`Hide`,`Rename`,`Uninstall` \ No newline at end of file diff --git a/docs/Work-Profile.md b/docs/Work-Profile.md new file mode 100644 index 0000000..38c6598 --- /dev/null +++ b/docs/Work-Profile.md @@ -0,0 +1,3 @@ +# Android Enterprise Work Profile + +µLauncher is compatible with [work profile](https://www.android.com/enterprise/work-profile/), so apps like [Shelter](https://gitea.angry.im/PeterCxy/Shelter) can be used. \ No newline at end of file diff --git a/launcher.wiki b/launcher.wiki deleted file mode 160000 index d40df78..0000000 --- a/launcher.wiki +++ /dev/null @@ -1 +0,0 @@ -Subproject commit d40df78a56336aa0ae26ad1308e4aac48456dff8