launcher/README.md

125 lines
6.5 KiB
Markdown
Raw Normal View History

2024-07-06 04:08:58 +02:00
<!-- Shields from shields.io -->
2024-10-17 20:19:26 +02:00
[![][shield-release]][latest-release]
2024-11-12 00:20:03 +01:00
[![Android CI](https://github.com/jrpie/Launcher/actions/workflows/android.yml/badge.svg)](https://github.com/jrpie/Launcher/actions/workflows/android.yml)
[![][shield-license]][license]
2024-10-09 01:56:28 +02:00
[![Chat on Matrix](https://matrix.to/img/matrix-badge.svg)][matrix]
2024-10-17 20:19:26 +02:00
[![Chat on Discord](https://img.shields.io/badge/discord-join%20chat-007ec6.svg?style=flat)][discord]
2024-10-09 01:56:28 +02:00
2024-11-12 00:20:03 +01:00
2024-08-02 22:46:18 +02:00
# μLauncher
2024-08-28 15:39:28 +02:00
2024-09-13 16:53:52 +02:00
µLauncher is an Android home screen that lets you launch apps using swipe gestures and button presses.
2024-08-28 15:39:28 +02:00
It is *minimal, efficient and free of distraction*.
Your home screen only displays the date, time and a wallpaper.
2024-11-26 02:34:06 +01:00
Pressing back or swiping up (this can be configured) opens a list
2024-08-28 15:39:28 +02:00
of all installed apps, which can be searched efficiently.
2024-07-06 04:08:58 +02:00
This is a fork of [finnmglas's app Launcher][original-repo].
2024-11-12 00:41:02 +01:00
2024-12-16 22:39:40 +01:00
<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>
2025-01-13 14:37:29 +01:00
<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>
2024-12-16 22:39:40 +01:00
<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>
2024-11-26 01:41:25 +01:00
You can also [get it on Google Play](https://play.google.com/store/apps/details?id=de.jrpie.android.launcher), but I don't recommend that.
2024-08-22 19:12:35 -04:00
2024-11-12 00:41:02 +01:00
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.jpg"
alt="screenshot"
height="400">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.jpg"
alt="screenshot"
height="400">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.jpg"
alt="screenshot"
height="400">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.jpg"
alt="screenshot"
height="400">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.jpg"
alt="screenshot"
height="400">
2024-12-06 01:59:50 +01:00
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.jpg"
alt="screenshot"
height="400">
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/8.jpg"
alt="screenshot"
height="400">
2024-11-12 00:41:02 +01:00
2024-08-28 15:39:28 +02:00
## Contributing
There are several ways to contribute to this app:
* You can add or improve [translations][toolate].
2024-11-26 01:41:25 +01:00
<br><img src="https://toolate.othing.xyz/widget/jrpie-launcher/launcher/horizontal-auto.svg" alt="translation status">
2024-11-27 16:46:23 +01:00
* If you find 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.
2024-08-28 15:39:28 +02:00
* You can implement a new feature yourself:
- Create a fork of this repository: [![][shield-gh-fork]][fork]
2025-01-13 14:37:29 +01:00
- Create a new branch named `feature/<your feature>` or `fix/<your fix>` and commit your changes.
2024-08-28 15:39:28 +02:00
- Open a new pull request.
2024-11-12 00:20:03 +01:00
See [BUILD.md](BUILD.md) for instructions how to build this project.
2025-01-13 14:37:29 +01:00
The [CI pipeline](https://github.com/jrpie/Launcher/actions) automatically creates debug builds.
Note that those are not signed.
2024-08-28 15:39:28 +02:00
## Notable changes compared to [Finn's Launcher][original-repo]:
2024-07-06 04:08:58 +02:00
2024-07-19 02:14:25 +02:00
* Edge gestures: There is a setting to allow distinguishing swiping at the edges of the screen from swiping in the center.
2024-08-02 22:32:35 +02:00
* Compatible with [work profile](https://www.android.com/enterprise/work-profile/), so apps like [Shelter](https://gitea.angry.im/PeterCxy/Shelter) can be used.
2024-08-28 15:39:28 +02:00
* The home button now works as expected.
2024-07-19 02:14:25 +02:00
2024-07-06 04:08:58 +02:00
### Visual
2024-07-19 15:00:55 +02:00
* This app uses the system wallpaper instead of a custom solution.
2024-07-02 21:21:51 +02:00
* The font has been changed to [Hack][hack-font].
2024-07-06 04:08:58 +02:00
* Font Awesome Icons were replaced by Material icons.
* The gear button on the home screen was removed. Instead pressing back opens the list of applications and the app settings are accessible from there.
### 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
* Small improvements to the gesture detection.
* Different apps set as default.
* 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)
2024-07-19 02:14:25 +02:00
* Some refactoring
---
---
2024-07-02 21:21:51 +02:00
[hack-font]: https://sourcefoundry.org/hack/
[original-repo]: https://github.com/finnmglas/Launcher
2024-08-28 15:39:28 +02:00
[toolate]: https://toolate.othing.xyz/projects/jrpie-launcher/
[issues]: https://github.com/jrpie/Launcher/issues/
[fork]: https://github.com/jrpie/Launcher/fork/
<!-- Download links / stores -->
2024-07-02 21:21:51 +02:00
[store-googleplay]: https://play.google.com/store/apps/details?id=de.jrpie.android.launcher
[store-googleplay-badgecampain]: https://play.google.com/store/apps/details?id=de.jrpie.android.launcher&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1
[store-fdroid]: https://f-droid.org/packages/de.jrpie.android.launcher/
<!-- Shields and Badges -->
2024-07-02 21:21:51 +02:00
[shield-release]: https://img.shields.io/github/v/release/jrpie/Launcher?style=flat
2024-10-17 20:19:26 +02:00
[latest-release]: https://github.com/jrpie/Launcher/releases/latest
[shield-contribute]: https://img.shields.io/badge/contributions-welcome-007ec6.svg?style=flat
[shield-license]: https://img.shields.io/badge/license-MIT-007ec6?style=flat
2024-07-02 21:21:51 +02:00
[shield-gh-watch]: https://img.shields.io/github/watchers/jrpie/Launcher?label=Watch&style=social
[shield-gh-star]: https://img.shields.io/github/stars/jrpie/Launcher?label=Star&style=social
[shield-gh-fork]: https://img.shields.io/github/forks/jrpie/Launcher?label=Fork&style=social
2024-10-09 01:56:28 +02:00
[matrix]: https://s.jrpie.de/launcher-matrix
2024-10-17 20:15:51 +02:00
[discord]: https://s.jrpie.de/launcher-discord
2024-11-27 16:46:23 +01:00
[chat]: https://s.jrpie.de/launcher-chat
<!-- Helpful resources -->
2024-07-02 21:21:51 +02:00
[license]: https://github.com/jrpie/Launcher/blob/master/LICENSE