README.md

   1 ![Taskbar](http://i.imgur.com/gttRian.png)
   2
   3 Taskbar puts a start menu and recent apps tray on top of your screen that's accessible at any time, increasing your productivity and turning your Android tablet (or phone) into a real multitasking machine!
   4
   5 Taskbar supports Android 10's Desktop Mode, allowing you to connect your compatible device to an external display and run apps in resizable windows, for a PC-like experience!  On devices running Android 7.0+, Taskbar can also launch apps in freeform windows without an external display.  No root required!  (see below for instructions)
   6
   7 Taskbar is also supported on Android TV (sideloaded) and Chrome OS - use Taskbar as a secondary Android app launcher on your Chromebook, or turn your Nvidia Shield into an Android-powered PC!
   8
   9 ## Features
  10 * Start menu - shows you all applications installed on the device, configurable as a list or as a grid
  11 * Recent apps tray - shows your most recently used apps and lets you easily switch between them
  12 * Collapsible and hideable - show it when you need it, hide it when you don't
  13 * Many different configuration options - customize Taskbar however you want
  14 * Pin favorite apps or block the ones you don't want to see
  15 * Designed with keyboard and mouse in mind
  16 * 100% free, open source, and no ads
  17
  18 #### Desktop mode (Android 10+, requires external display)
  19 Taskbar supports Android 10's built-in desktop mode functionality. You can connect your compatible Android 10+ device to an external display and run apps in resizable windows, with Taskbar's interface running on your external display and your existing launcher still running on your phone.
  20
  21 Desktop mode requires a USB-to-HDMI adapter (or a lapdock), and a compatible device that supports video output. Additionally, certain settings require granting a special permission via adb.
  22
  23 To get started, open up the Taskbar app and click "Desktop mode". Then, just tick the checkbox and the app will guide you through the setup process. For more information, click the (?) icon in the upper-right hand corner of the screen.
  24
  25 #### Freeform window mode (Android 7.0+, no external display required)
  26 Taskbar lets you launch apps in freeform floating windows on Android 7.0+ devices.  No root access is required, although Android 8.0, 8.1, and 9 devices require an adb shell command to be run during initial setup.
  27
  28 Simply follow these steps to configure your device for launching apps in freeform mode:
  29
  30 1. Check the box for "Freeform window support" inside the Taskbar app
  31 2. Follow the directions that appear in the pop-up to enable the proper settings on your device (one-time setup)
  32 3. Go to your device's recent apps page and clear all recent apps
  33 4. Start Taskbar, then select an app to launch it in a freeform window
  34
  35 For more information and detailed instructions, click "Help & instructions for freeform mode" inside the Taskbar app.
  36
  37 ## Changelog
  38 To see some of the major new features in the latest Taskbar release, visit the [changelog](https://github.com/farmerbb/Taskbar/blob/master/CHANGELOG.md).
  39
  40 ## Download
  41 Taskbar can be downloaded as a standalone Android app from:
  42
  43 [<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
  44       alt="Google Play"
  45       height="80"
  46       align="middle">](https://play.google.com/store/apps/details?id=com.farmerbb.taskbar)
  47 [<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
  48       alt="F-Droid"
  49       height="80"
  50       align="middle">](https://f-droid.org/packages/com.farmerbb.taskbar/)
  51
  52 Taskbar is also included as part of the following Android distributions for PCs:
  53
  54 * Android-x86 (7.1-rc2 and later) (http://www.android-x86.org)
  55 * Bliss OS (x86 builds) (https://blissroms.com)
  56
  57 ## How to Build
  58 Prerequisites:
  59 * Windows / MacOS / Linux
  60 * JDK 8
  61 * Android SDK
  62 * Internet connection (to download dependencies)
  63
  64 Once all the prerequisites are met, make sure that the `ANDROID_HOME` environment variable is set to your Android SDK directory, then run `./gradlew assembleFreeDebug` at the base directory of the project to start the build. After the build completes, navigate to `app/build/outputs/apk/free/debug` where you will end up with an APK file ready to install on your Android device.
  65
  66 ### Running tests
  67
  68 Taskbar uses [Robolectric](https://github.com/robolectric/robolectric) as its unit testing framework.  The entire test suite can be run with `./gradlew test`, or you can generate a Jacoco coverage report using `./gradlew jacocoTestReport`.  If you contribute code improvements such as bug fixes, we recommend writing tests alongside it using Robolectric.
  69
  70 ## For Third-Party App Developers
  71
  72 #### Android 10 Desktop Mode support via libtaskbar
  73 Taskbar can now be included as a library inside any third-party launcher, to quickly and easily add Android 10 Desktop Mode support into your existing launcher with no additional setup.
  74
  75 For more information on including Taskbar inside your application, see the [libtaskbar documentation](https://github.com/farmerbb/libtaskbar/blob/master/README.md).
  76
  77 #### Icon Pack Support
  78 Taskbar includes support for ADW-style icon packs.  If you are an icon pack developer and would like to include support for applying the icon pack from within your app, simply use the following code:
  79
  80     Intent intent = new Intent("com.farmerbb.taskbar.APPLY_ICON_PACK");
  81     intent.putExtra("android.intent.extra.PACKAGE_NAME", "com.iconpack.name");
  82     startActivity(intent);
  83
  84 ## Contributors
  85
  86 Pull requests are welcome!  See the [contributor guidelines](https://github.com/farmerbb/Taskbar/blob/master/CONTRIBUTING.md) for more details.
  87
  88 * Mark Morilla (app logo)
  89 * naofum (Japanese translation)
  90 * HardSer (Russian translation)
  91 * OfficialMITX (German translation)
  92 * Whale Majida (Chinese translation)
  93 * Mesut Han (Turkish translation)
  94 * Zbigniew Zienko (Polish translation)
  95 * utzcoz (Additional Chinese translation, code cleanup + unit testing)
  96 * RaspberryPiFan (Additional German translation)
  97 * Diego Sangunietti (Spanish translation)
  98 * Tommy He (Chinese translation for Desktop Mode)
  99 * Aaron Dewes (German translation updates)
 100
 101 #### Special Thanks
 102 * Mishaal Rahman (xda-developers)
 103 * Jon West (Team Bliss)
 104 * Chih-Wei Huang (Android-x86)