mirror of
https://github.com/jrpie/Launcher.git
synced 2025-05-10 12:34:17 +02:00
improve codestyle
This commit is contained in:
Luke Wass
parent
b2b823446f
commit
8f9f8ac928
7 changed files with 111 additions and 85 deletions
|
|
@ -1,4 +1,6 @@
|
|||
# Using the command line
|
||||
# Building from Source
|
||||
|
||||
## Using the command line
|
||||
|
||||
Install JDK 17 and the Android SDK.
|
||||
Make sure that `JAVA_HOME` and `ANDROID_HOME` are set correctly.
|
||||
|
|
@ -13,6 +15,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" \
|
||||
|
|
@ -29,15 +32,14 @@ apksigner sign --ks "$YOUR_KEYSTORE" \
|
|||
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. How to
|
||||
|
||||
# CI Pipeline
|
||||
## CI Pipeline
|
||||
|
||||
The [CI pipeline](https://github.com/jrpie/Launcher/actions) automatically creates debug builds.
|
||||
> Note: These builds are *not* signed.
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
# Notable changes compared to [Finn's Launcher][original-repo]:
|
||||
# Notable changes compared to Finn's Launcher
|
||||
|
||||
µLauncher is a fork of [finnmglas's app Launcher][original-repo].
|
||||
µLauncher is a fork of [finnmglas's app Launcher](https://github.com/finnmglas/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.
|
||||
The decision to create a hard fork was made two years later.-->
|
||||
|
||||
|
||||
- Additional gestures:
|
||||
- Back
|
||||
- V,Λ,<,>
|
||||
- Edge gestures: There is a setting to allow distinguishing swiping at the edges of the screen from swiping in the center.
|
||||
- Back
|
||||
- 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.
|
||||
- Compatible with [private space](https://source.android.com/docs/security/features/private-space)
|
||||
- Option to rename apps
|
||||
|
|
@ -23,18 +23,20 @@ The decision to create a hard fork was made two years later.-->
|
|||
- The home button now works as expected.
|
||||
- Improved gesture detection.
|
||||
|
||||
### Visual
|
||||
## Visual
|
||||
|
||||
- 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.
|
||||
|
||||
## Search
|
||||
|
||||
### 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 bar was moved to the bottom of the screen.
|
||||
|
||||
### Technical
|
||||
## Technical
|
||||
|
||||
- Improved gesture detection.
|
||||
- Different apps set as default.
|
||||
- Package name was changed to `de.jrpie.android.launcher` to avoid clashing with the original app.
|
||||
|
|
@ -42,9 +44,10 @@ The decision to create a hard fork was made two years later.-->
|
|||
- Fixed some bugs
|
||||
- Some refactoring
|
||||
|
||||
|
||||
The complete list of changes can be viewed [here](https://github.com/jrpie/launcher/compare/340ee731...master).
|
||||
|
||||
---
|
||||
[original-repo]: https://github.com/finnmglas/Launcher
|
||||
[hack-font]: https://sourcefoundry.org/hack/
|
||||
|
||||
[original-repo]: https://github.com/finnmglas/Launcher
|
||||
|
||||
[hack-font]: https://sourcefoundry.org/hack/
|
||||
|
|
|
|||
|
|
@ -1,10 +1,17 @@
|
|||
# Ways to contribute
|
||||
# Contributing
|
||||
|
||||
## 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/\<your feature\>* or *fix/\<your fix\>* and commit your changes.
|
||||
3. Open a new pull request.
|
||||
|
||||
- Add or improve [translations](https://toolate.othing.xyz/projects/jrpie-launcher/).
|
||||
<img src="https://toolate.othing.xyz/widget/jrpie-launcher/launcher/horizontal-auto.svg" alt="translation status">
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,41 +1,52 @@
|
|||
# Available Gestures
|
||||
## Swipes
|
||||
# Gestures and Bindings
|
||||
|
||||
## 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
|
||||
### Taps
|
||||
|
||||
- Tap on date or time.
|
||||
- Double tap.
|
||||
- Long tap.
|
||||
|
||||
## Tap-then-Swipes
|
||||
tap then swipe up, down, left, or right
|
||||
### Tap-then-Swipes
|
||||
|
||||
Tap then swipe up, down, left, or right
|
||||
|
||||
### Complex Gestures
|
||||
|
||||
## Complex Gestures
|
||||
- Draw <, >, V, or Λ.
|
||||
- Draw <, >, V, or Λ in reverse direction.
|
||||
|
||||
## Hardware Buttons as Gestures
|
||||
### Hardware Buttons as Gestures
|
||||
|
||||
- Back button.
|
||||
- Volume up or down button.
|
||||
|
||||
|
||||
***
|
||||
|
||||
## Available Bindings
|
||||
|
||||
# Available Bindings
|
||||
Any of the above gestures can be bound to any of the following bindings.
|
||||
## Launcher Bindings
|
||||
|
||||
### Launcher Bindings
|
||||
|
||||
- Open µLauncher settings.
|
||||
- Open a list of all*, favorite, or private* apps.
|
||||
|
||||
## App Bindings
|
||||
### App Bindings
|
||||
|
||||
- Launch an app.
|
||||
- Launch another Home Screen.
|
||||
|
||||
## Android / Device Bindings
|
||||
### Android / Device Bindings
|
||||
|
||||
- Toggle private space lock.
|
||||
- Lock the screen.
|
||||
- Toggle the torch (flashlight)
|
||||
|
|
@ -44,4 +55,4 @@ Any of the above gestures can be bound to any of the following bindings.
|
|||
- Open Notifications shade.
|
||||
- Open Quick Settings shade.
|
||||
|
||||
> \* excludes apps hidden by the user
|
||||
> \* excludes apps hidden by the user
|
||||
|
|
|
|||
59
docs/Home.md
59
docs/Home.md
|
|
@ -1,37 +1,38 @@
|
|||
# Welcome to the μLauncher wiki!
|
||||
# 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?
|
||||
## 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?
|
||||
<a href="https://f-droid.org/packages/de.jrpie.android.launcher/"><img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80"></a>
|
||||
<a href="https://accrescent.app/app/de.jrpie.android.launcher.accrescent"><img alt="Get it on Accrescent" src="https://accrescent.app/badges/get-it-on.png" height="80"></a>
|
||||
<a href="https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/{%22id%22:%22de.jrpie.android.launcher%22,%22url%22:%22https://github.com/jrpie/Launcher%22,%22author%22:%22jrpie%22,%22name%22:%22%c2%b5Launcher%22,%22additionalSettings%22:%22{\%22apkFilterRegEx\%22:\%22release\%22,\%22invertAPKFilter\%22:false,\%22about\%22:\%22%c2%b5Launcher%20is%20a%20minimal%20home%20screen.\%22}%22}"><img src="https://raw.githubusercontent.com/ImranR98/Obtainium/b1c8ac6f2ab08497189721a788a5763e28ff64cd/assets/graphics/badge_obtainium.png" alt="Get it on Obtainium" height="80"></a>
|
||||
<a href="https://github.com/jrpie/launcher/releases/latest"><img src="https://raw.githubusercontent.com/NeoApplications/Neo-Backup/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png" alt="Get it on GitHub" height="80"></a>
|
||||
## Where can I get μLauncher
|
||||
|
||||
[](https://f-droid.org/packages/de.jrpie.android.launcher/)
|
||||
|
||||
[](https://accrescent.app/app/de.jrpie.android.launcher.accrescent)
|
||||
|
||||
[](https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/{%22id%22:%22de.jrpie.android.launcher%22,%22url%22:%22https://github.com/jrpie/Launcher%22,%22author%22:%22jrpie%22,%22name%22:%22%c2%b5Launcher%22,%22additionalSettings%22:%22{\%22apkFilterRegEx\%22:\%22release\%22,\%22invertAPKFilter\%22:false,\%22about\%22:\%22%c2%b5Launcher%20is%20a%20minimal%20home%20screen.\%22}%22})
|
||||
|
||||
[](https://github.com/jrpie/launcher/releases/latest)
|
||||
|
||||
> 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
|
||||
<img src="https://github.com/jrpie/launcher/blob/master/fastlane/metadata/android/en-US/images/phoneScreenshots/1.jpg"
|
||||
alt="μLauncher Home Screen screenshot"
|
||||
height="400">
|
||||
<img src="https://github.com/jrpie/launcher/blob/master/fastlane/metadata/android/en-US/images/phoneScreenshots/2.jpg"
|
||||
alt="μLauncher Settings screenshot"
|
||||
height="400">
|
||||
<img src="https://github.com/jrpie/launcher/blob/master/fastlane/metadata/android/en-US/images/phoneScreenshots/3.jpg"
|
||||
alt="μLauncher All Apps list view with icons screenshot"
|
||||
height="400">
|
||||
<img src="https://github.com/jrpie/launcher/blob/master/fastlane/metadata/android/en-US/images/phoneScreenshots/4.jpg"
|
||||
alt="μLauncher Favorite Apps list view with icons screenshot"
|
||||
height="400">
|
||||
<img src="https://github.com/jrpie/launcher/blob/master/fastlane/metadata/android/en-US/images/phoneScreenshots/5.jpg"
|
||||
alt="μLauncher Choose App to bind to gesture screenshot"
|
||||
height="400">
|
||||
<img src="https://github.com/jrpie/launcher/blob/master/fastlane/metadata/android/en-US/images/phoneScreenshots/7.jpg"
|
||||
alt="μLauncher App options card from list view with icons screenshot"
|
||||
height="400">
|
||||
<img src="https://github.com/jrpie/launcher/blob/master/fastlane/metadata/android/en-US/images/phoneScreenshots/8.jpg"
|
||||
alt="μLauncher All Apps list view without icons screenshot"
|
||||
height="400">
|
||||
<!-- missing μLauncher grid view screenshot-->
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- missing μLauncher grid view screenshot-->
|
||||
|
|
|
|||
|
|
@ -1,19 +1,20 @@
|
|||
# Launcher Settings
|
||||
|
||||
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
|
||||
|
||||
# Appearance
|
||||
> ### Choose a wallpaper
|
||||
|
||||
### Choose a wallpaper</summary>
|
||||
Lets you change the wallpaper using a photos app, file explorer, or native wallpaper setting app.
|
||||
</details>
|
||||
|
||||
> ### Font
|
||||
> ### Font (in-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).
|
||||
Set the font used within the app settings. This setting does not affect the date/time home screen font.
|
||||
|
||||
**type:** `dropdown`
|
||||
|
||||
|
|
@ -35,12 +36,11 @@ Remove coloring from all app icons. Can help decrease visual stimulus when enabl
|
|||
|
||||
**type:** `toggle`
|
||||
|
||||
## Date & Time
|
||||
|
||||
# Date & Time
|
||||
> ### Font (home screen)
|
||||
|
||||
> ### 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).
|
||||
Set the home screen font for date and time. This setting does not affect the in-app font.
|
||||
|
||||
**type:** `dropdown`
|
||||
|
||||
|
|
@ -86,8 +86,7 @@ Place the current time above the current date on the home screen.
|
|||
|
||||
**type:** `toggle`
|
||||
|
||||
|
||||
# Functionality
|
||||
## Functionality
|
||||
|
||||
> ### Launch search results
|
||||
|
||||
|
|
@ -134,20 +133,24 @@ 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.
|
||||
|
||||
1. **`Device Admin`**
|
||||
- Doesn't work with unlocking by fingerprint or face recognition.
|
||||
|
||||
- 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.
|
||||
|
||||
- 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`
|
||||
**type:** `text buttons`
|
||||
|
||||
**options:** `USE DEVICE ADMIN`,`USE ACCESSIBILITY SERVICE`
|
||||
**options:** `USE DEVICE ADMIN`,`USE ACCESSIBILITY SERVICE`
|
||||
|
||||
# Apps
|
||||
## Apps
|
||||
|
||||
> ### Hidden apps
|
||||
|
||||
|
|
@ -187,8 +190,7 @@ Enable Z-A sorting of apps in the app drawer. Useful for keeping apps within eas
|
|||
|
||||
**type:** `toggle`
|
||||
|
||||
|
||||
# Display
|
||||
## Display
|
||||
|
||||
> ### Rotate screen
|
||||
|
||||
|
|
@ -210,8 +212,7 @@ Remove the navigation bar from the home screen. Enabling this setting may make i
|
|||
|
||||
**type:** `toggle`
|
||||
|
||||
|
||||
# Additional Settings
|
||||
## Additional Settings
|
||||
|
||||
> ### App Drawer Long Press on App
|
||||
|
||||
|
|
@ -219,4 +220,4 @@ Access additional per-app details and settings. To use, open the app drawer and
|
|||
|
||||
**type:** `dropdown`
|
||||
|
||||
**options:** `App Info`,`Add to favorites`,`Hide`,`Rename`,`Uninstall`
|
||||
**options:** `App Info`,`Add to favorites`,`Hide`,`Rename`,`Uninstall`
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
# 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.
|
||||
µ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.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue