From ea5a4ad7bfd4b03a132c719ce94b1512620d73a4 Mon Sep 17 00:00:00 2001 From: Josia Pietsch Date: Sat, 24 May 2025 19:22:08 +0200 Subject: [PATCH 1/4] add example to docs --- docs/actions-and-gestures.md | 4 ++++ docs/alternatives.md | 5 ++++- docs/build.md | 5 +++++ docs/contributing.md | 5 +++++ docs/examples/_index.md | 5 +++++ docs/examples/apps-on-home-screen.md | 18 ++++++++++++++++++ docs/profiles.md | 6 ++++++ docs/settings.md | 4 ++++ docs/widgets.md | 1 + 9 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 docs/examples/apps-on-home-screen.md diff --git a/docs/actions-and-gestures.md b/docs/actions-and-gestures.md index a5348a3..dc00970 100644 --- a/docs/actions-and-gestures.md +++ b/docs/actions-and-gestures.md @@ -1,3 +1,7 @@ ++++ + weight = 10 ++++ + # Actions and Gestures µLauncher's central mechanism for accessing important functionality quickly diff --git a/docs/alternatives.md b/docs/alternatives.md index 4c875f4..174ee8a 100644 --- a/docs/alternatives.md +++ b/docs/alternatives.md @@ -1,3 +1,6 @@ ++++ + weight = 100 ++++ -TODO: move the [hedgedoc](https://pad.abstractnonsen.se/foss-launchers) document here. +ODO: move the [hedgedoc](https://pad.abstractnonsen.se/foss-launchers) document here. diff --git a/docs/build.md b/docs/build.md index 1ffc338..a45ab4c 100644 --- a/docs/build.md +++ b/docs/build.md @@ -1,3 +1,8 @@ ++++ + weight = 50 ++++ + + # Building from Source ## Using the command line diff --git a/docs/contributing.md b/docs/contributing.md index 350ba01..f74bcca 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,3 +1,8 @@ ++++ + weight = 40 ++++ + + # Contributing There are several ways to contribute to this app: diff --git a/docs/examples/_index.md b/docs/examples/_index.md index 0847315..b50540f 100644 --- a/docs/examples/_index.md +++ b/docs/examples/_index.md @@ -1,2 +1,7 @@ ++++ + bookCollapseSection = true + weight = 20 ++++ + # Examples This section contains some examples how μLauncher can be tweaked. diff --git a/docs/examples/apps-on-home-screen.md b/docs/examples/apps-on-home-screen.md new file mode 100644 index 0000000..f63c500 --- /dev/null +++ b/docs/examples/apps-on-home-screen.md @@ -0,0 +1,18 @@ ++++ + title = 'Showing Apps on the Home Screen' ++++ + +# Showing Apps on the Home Screen + +Even though this is somewhat contrary to the general idea of μLauncher, +it is possible to show apps on the home screen using widgets. + +Users suggested: +* [Launchy](https://launchywidget.com/) (proprietary!) +* KWGT Kustom Widget Maker (proprietary!) + +{{% hint danger %}} +Both of these apps are not open source and KWGT even has ads. + +Please contact me if you know FOSS alternatives! +{{% /hint %}} diff --git a/docs/profiles.md b/docs/profiles.md index d9eaf52..2087d06 100644 --- a/docs/profiles.md +++ b/docs/profiles.md @@ -1,3 +1,9 @@ ++++ + title = 'User Profiles' + weight = 12 ++++ + + # 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. diff --git a/docs/settings.md b/docs/settings.md index 3cbfbec..eff0417 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -1,3 +1,7 @@ ++++ + weight = 10 ++++ + # Settings Tweaks and customizations can be made from within the settings page. diff --git a/docs/widgets.md b/docs/widgets.md index ab5e21f..acbdf05 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -1,5 +1,6 @@ +++ title = 'Widgets' + weight = 11 +++ # Widgets From 580644f9d4a756499c31277a3d4170afca838977 Mon Sep 17 00:00:00 2001 From: Josia Pietsch Date: Sat, 24 May 2025 20:29:01 +0200 Subject: [PATCH 2/4] add documentation of app drawer --- docs/app-drawer.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++ docs/settings.md | 10 --------- 2 files changed, 54 insertions(+), 10 deletions(-) create mode 100644 docs/app-drawer.md diff --git a/docs/app-drawer.md b/docs/app-drawer.md new file mode 100644 index 0000000..d977c28 --- /dev/null +++ b/docs/app-drawer.md @@ -0,0 +1,54 @@ ++++ + weight = 10 ++++ + +# App Drawer + +Apps that are not needed all the time are shown in the app drawer. +There are several such drawers, but the basic concept is the same. +Besides regular apps, app drawers also show [pinned shortcuts](https://developer.android.com/develop/ui/views/launch/shortcuts/creating-shortcuts)[^1]. +μ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. +This can be prevented by typing space. +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. +[^2]: There are [several settings](/docs/settings/#functionality) available to modify the behavior. + +When long clicking 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. +* App Info: Opens the system settings page for the app. +* Uninstall: Tries to uninstall the app or remove the shortcut. + +## All Apps + +This lists all apps except hidden apps. +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 +only favorite apps should be shown. +Additionally the `Favorite Apps` action can be used to launch this drawer directly. +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. + +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). + +## 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). diff --git a/docs/settings.md b/docs/settings.md index eff0417..eb780fc 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -234,13 +234,3 @@ Remove the top status bar from the home screen. 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` From 71193a2e50b03bf46f16a37cdea357740563fb74 Mon Sep 17 00:00:00 2001 From: Josia Pietsch Date: Sat, 24 May 2025 20:34:15 +0200 Subject: [PATCH 3/4] fixed typo --- docs/build.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build.md b/docs/build.md index a45ab4c..3d1605c 100644 --- a/docs/build.md +++ b/docs/build.md @@ -42,7 +42,7 @@ for further instructions. 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 +for further instructions. ## CI Pipeline From 1d10d65adbc35c4f18945fe4edc41b10a6177365 Mon Sep 17 00:00:00 2001 From: Josia Pietsch Date: Sat, 24 May 2025 20:41:37 +0200 Subject: [PATCH 4/4] update documentation --- docs/build.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/build.md b/docs/build.md index 3d1605c..28e889a 100644 --- a/docs/build.md +++ b/docs/build.md @@ -47,4 +47,8 @@ for further instructions. ## CI Pipeline The [CI pipeline](https://github.com/jrpie/Launcher/actions) automatically creates debug builds. -> Note: These builds are *not* signed. They are in built in debug mode and only suitable for testing. + +{{% hint warning %}} +Note: These builds are not signed. +They are in built in debug mode and only suitable for testing. +{{% /hint %}}