diff --git a/README.md b/README.md index b29b44d..016b362 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,6 @@ µLauncher is an Android home screen that lets you launch apps using swipe gestures and button presses. It is *minimal, efficient and free of distraction*. -Your home screen only displays the date, time and a wallpaper. -Pressing back or swiping up (this can be configured) opens a list -of all installed apps, which can be searched efficiently. - -This is a fork of [finnmglas's app Launcher][original-repo]. - Get it on F-Droid Get it on Accrescent @@ -51,6 +45,45 @@ You can also [get it on Google Play](https://play.google.com/store/apps/details? height="400"> +µLauncher is a fork of [finnmglas's app Launcher][original-repo]. +An incomplete list of changes can be found [here](docs/launcher.md). + +## Features + +µLauncher only displays the date, time and a wallpaper. +Pressing back or swiping up (this can be configured) opens a list +of all installed apps, which can be searched efficiently. + +The following gestures are available: + - volume up / down, + - swipe up / down / left / right, + - swipe with two fingers, + - swipe on the left / right resp. top / bottom edge, + - draw < / > / V / Λ + - click on date / time, + - double click, + - long click, + - back button. + +To every gesture you can bind one of the following actions: + - launch an app, + - open a list of all / favorite / private apps, + - open µLauncher settings, + - toggle private space lock, + - lock the screen, + - toggle the torch, + - volume up / down, + - go to previous / next audio track. + + + +µ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. + +By default the font is set to [Hack][hack-font], but other fonts can be selected. + + + ## Contributing There are several ways to contribute to this app: @@ -63,34 +96,10 @@ There are several ways to contribute to this app: - Open a new pull request. -See [BUILD.md](BUILD.md) for instructions how to build this project. +See [build.md](docs/build.md) for instructions how to build this project. The [CI pipeline](https://github.com/jrpie/Launcher/actions) automatically creates debug builds. Note that those are not signed. -## Notable changes compared to [Finn's Launcher][original-repo]: - -* 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. -* The home button now works as expected. - -### Visual -* This app uses the system wallpaper instead of a custom solution. -* The font has been changed to [Hack][hack-font]. -* 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) -* Some refactoring ---- --- [hack-font]: https://sourcefoundry.org/hack/ [original-repo]: https://github.com/finnmglas/Launcher diff --git a/BUILD.md b/docs/build.md similarity index 100% rename from BUILD.md rename to docs/build.md diff --git a/docs/launcher.md b/docs/launcher.md new file mode 100644 index 0000000..37b24a4 --- /dev/null +++ b/docs/launcher.md @@ -0,0 +1,49 @@ +# Notable changes compared to [Finn's Launcher][original-repo]: + +µLauncher is a fork of [finnmglas's app Launcher][original-repo]. +Here is an incomplete list of changes: + + + +- 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. +- 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 +- Option to hide apps +- Favorite apps +- New actions: + - Toggle Torch + - Lock screen +- The home button now works as expected. +- Improved gesture detection. + +### 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 +- 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. +- 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) +- 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