OSDN Git Service

Revert "Switch to LOCAL_STATIC_ANDROID_LIBRARIES"
[android-x86/packages-apps-Taskbar.git] / README.md
index 4786b20..eea7770 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
-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!<br><br>On devices running Android 7.0 Nougat, Taskbar can also launch apps in freeform windows for a PC-like experience!  No root required!  (see below for instructions)
+![Taskbar](http://i.imgur.com/gttRian.png)
+
+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!
+
+On devices running Android 7.0+, Taskbar can also launch apps in freeform windows for a PC-like experience!  No root required!  (see below for instructions)
+
+Taskbar is also fully supported on Chrome OS - use Taskbar as a secondary Android app launcher on your Chromebook!
 
 ## Features
 * Start menu - shows you all applications installed on the device, configurable as a list or as a grid
 * Designed with keyboard and mouse in mind
 * 100% free, open source, and no ads
 
-#### Freeform window mode (Android 7.0 Nougat)
+#### Freeform window mode (Android 7.0+)
 
-Taskbar lets you launch apps in freeform floating windows on Android 7.0 Nougat.  No root access is required.  Simply follow these steps to configure your device for launching apps in freeform mode:
+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.
+
+Simply follow these steps to configure your device for launching apps in freeform mode:
 
 1. Check the box for "Freeform window support" inside the Taskbar app
-2. Follow the directions that appear in the pop-up to enable the proper settings on your device
-3. With Taskbar turned on, go to your device's recent apps page
-4. Clear all recent apps, then go back to the (empty) recent apps page
-5. Press Taskbar's start button and select an app to launch it in a freeform window
+2. Follow the directions that appear in the pop-up to enable the proper settings on your device (one-time setup)
+3. Go to your device's recent apps page and clear all recent apps
+4. Start Taskbar, then select an app to launch it in a freeform window
 
 For more information and detailed instructions, click "Help & instructions for freeform mode" inside the Taskbar app.
 
+## Changelog
+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).
+
 ## Download
-* Google Play (https://play.google.com/store/apps/details?id=com.farmerbb.taskbar)
-* F-Droid (https://f-droid.org/repository/browse/?fdid=com.farmerbb.taskbar)
-* APKMirror (http://www.apkmirror.com/apk/braden-farmer/taskbar/)
+Taskbar can be downloaded as a standalone Android app from:
+
+[<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
+      alt="Google Play"
+      height="80"
+      align="middle">](https://play.google.com/store/apps/details?id=com.farmerbb.taskbar)
+[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
+      alt="F-Droid"
+      height="80"
+      align="middle">](https://f-droid.org/packages/com.farmerbb.taskbar/)
+
+Taskbar is also included as part of the following Android distributions for PCs:
+
+* Android-x86 (7.1-rc2 and later) (http://www.android-x86.org)
+* Bliss OS (x86 builds) (https://blissroms.com)
 
 ## How to Build
 Prerequisites:
-* Windows, Mac, or Linux machine
+* Windows / MacOS / Linux
 * JDK 8
+* Android SDK
 * Internet connection (to download dependencies)
 
-Once all the prerequisites are met, simply cd to the base directory of the project and run "./gradlew assembleDebug" to start the build.  Dependencies will download and the build will run.  After the build completes, cd to "app/build/outputs/apk" where you will end up with the APK files "app-free-debug.apk" and "app-paid-debug.apk", ready to install on your Android device.
+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.
+
+## Android 10 Desktop Mode support via libtaskbar
+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.
+
+For more information on including Taskbar inside your application, see the [libtaskbar documentation](https://github.com/farmerbb/Taskbar/blob/master/lib/README.md).
 
 ## Icon Pack Support
 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:
 
     Intent intent = new Intent("com.farmerbb.taskbar.APPLY_ICON_PACK");
-    intent.putExtra(Intent.EXTRA_PACKAGE_NAME, "com.iconpack.name");
+    intent.putExtra("android.intent.extra.PACKAGE_NAME", "com.iconpack.name");
     startActivity(intent);
 
-## Translation Credits
-* Braden Farmer (English)
-* naofum (Japanese)
+## Contributors
+* Mark Morilla (app logo)
+* naofum (Japanese translation)
+* HardSer (Russian translation)
+* OfficialMITX (German translation)
+* Whale Majida (Chinese translation)
+* Mesut Han (Turkish translation)
+
+#### Special Thanks
+* Mishaal Rahman (xda-developers)
+* Jon West (Team Bliss)
+* Chih-Wei Huang (Android-x86)