diff --git a/docs/html/images/tools/as-debugbutton.png b/docs/html/images/tools/as-debugbutton.png index 55e95d1b6668d..f8edf4d550581 100644 Binary files a/docs/html/images/tools/as-debugbutton.png and b/docs/html/images/tools/as-debugbutton.png differ diff --git a/docs/html/images/tools/as-find-apk.png b/docs/html/images/tools/as-find-apk.png new file mode 100644 index 0000000000000..e68d2b15b0cb5 Binary files /dev/null and b/docs/html/images/tools/as-find-apk.png differ diff --git a/docs/html/images/tools/as-gradle.png b/docs/html/images/tools/as-gradle.png new file mode 100644 index 0000000000000..a1b88ae8711fe Binary files /dev/null and b/docs/html/images/tools/as-gradle.png differ diff --git a/docs/html/images/tools/as-run.png b/docs/html/images/tools/as-run.png index 76c7020db4341..dbc3e33bec988 100644 Binary files a/docs/html/images/tools/as-run.png and b/docs/html/images/tools/as-run.png differ diff --git a/docs/html/images/tools/signstudio3.png b/docs/html/images/tools/signstudio3.png index f25bf002cfad9..4d51764d94dbf 100644 Binary files a/docs/html/images/tools/signstudio3.png and b/docs/html/images/tools/signstudio3.png differ diff --git a/docs/html/tools/building/building-studio.jd b/docs/html/tools/building/building-studio.jd index ef6e94bcfb23f..2e3615e44a0df 100644 --- a/docs/html/tools/building/building-studio.jd +++ b/docs/html/tools/building/building-studio.jd @@ -6,239 +6,182 @@ parent.link=index.html

In this document

-
    -
  1. Building your Project in Android Studio
      -
    1. Build a release version
    2. +
    3. Changing the run configuration
    4. +
    5. Changing build variants
    6. +
    7. Monitoring the build process
    8. +
    9. Generating APKs
    -
  2. -
  3. Running your App + +

    See also

      -
    1. Creating a Run Configuration
    2. -
    3. Automatic and manual target modes
    4. -
    5. Running on an Emulator
    6. -
    7. Running on a Device
    8. +
    9. + Build System
    10. +
    11. + Managing AVDs with AVD Manager
    12. +
    13. + Using the Android Emulator
    14. +
    15. + Using Hardware Devices
    16. +
    17. + Signing Your Applications
    -
  4. -
- -

See also

-
    -
  1. - Build System
  2. -
  3. - Managing AVDs with AVD Manager
  4. -
  5. - Using the Android Emulator
  6. -
  7. - Signing Your Applications
  8. -
  9. Deep Link and App Indexing API Support in Android Studio
  10. -
-
+

+ By default, Android Studio sets up new projects to deploy to the Emulator or + a physical device with just a few clicks. +

-

This document shows you how to use Android Studio to build an application .apk for -testing or release and how to run your application on an emulator or a real device.

+

+ To build and run your app, click Run 'app' . Android Studio builds your app with + Gradle, asks you to select a deployment target (an emulator or a connected + device), and then deploys your app to it. You can customize some of this + default behavior, such as selecting an automatic deployment target, by + changing the run configuration. +

+

+ If you want to use the Android + Emulator to run your app, you need to have an Android Virtual Device + (AVD) ready. If you haven't already created one, then after you click + Run 'app', click Create New Emulator in the + Select Deployment Target dialog. Follow the Virtual Device + Configuration wizard to define the type of device you want to emulate. For + more information, see Managing AVDs with the AVD + Manager. +

-

Build your Project in Android Studio

+

+ If you're using a physical Android device, you need to enable USB debugging + on the device. For more information, see Using Hardware Devices. +

-

To build the project on Android Studio, click Build and select -Make Project. The status bar at the bottom of the window shows the current -progress of the build:

+

+ Note: You can also deploy your app in debug mode by clicking + Debug 'app' . Running your app in debug mode + allows you to set breakpoints in your code, examine variables and evaluate + expressions at run time, and run debugging tools. To learn more, read about + Debugging with + Android Studio. +

-

Gradle: Executing tasks: [:app:assembleDebug, :lib:bundleDebug]

+

+ Changing the run configuration +

-

Click on the bottom -right part of the window to show the Gradle Console, as shown in figure 1.

+

+ The run configuration specifies the module to run, package to deploy, + activity to start, target device, emulator settings, and Logcat options. The + default run configuration launches the default project activity and uses the + Device Chooser for target device selection. If the default + settings don't suit your project or module, you can customize the run + configuration, or even create a new one, at the project, default, and module + levels. To edit a run configuration: +

- -

Figure 1. The Gradle Console in Android Studio.

+
    +
  1. Select Run > Edit Configurations. +
  2. -

    The Gradle Console shows the build tasks and subtasks that the build system runs for -Android Studio. If the build fails, you can find more details on the console. To hide the Gradle -Console, click again.

    - -

    If your project uses product flavors, Android Studio invokes the task for the -selected build variant. For more information, see the -Build System guide.

    - -

    To view the list of all available build tasks in Android Studio, click Gradle -on the right side of the IDE window. The Gradle tasks panel appears.

    - - -

    Build a release version

    - -

    You can now use the Build menu options to build the release version of your -application for distribution.

    - -

    The build generates an APK for each build variant: -the app/build/apk/ directory contains packages named -app-<flavor>-<buildtype>.apk; for example, app-full-release.apk and -app-demo-debug.apk.

    - - -

    For more build system information, see -Build System.

    - - -

    Running your app

    - -

    This section shows you how to run your application on an emulator or a real device - from Android Studio—all of which is done using the debug version of your application. - For more information about how to sign your application with a private key for release, see - Signing Your Applications

    - - -

    Creating a Run Configuration

    - -

    The run configuration specifies the module to run, package to deploy, Activity to start, - target device, emulator settings, and Logcat options. Run configuration can be set at the project, - default, and module levels. When you first run a module as an Android Application, - Android Studio will automatically create a run configuration. The default run - configuration will launch the default project Activity and use automatic target mode for device - selection (with no preferred AVD). If the default settings don't suit your project or module, you - can customize the run configuration or even create a new one.

    - -

    To create or modify a run configuration, see the IntelliJ documentation on - - Run/Debug configurations.

    - -

    The following steps highlight the important things you need to do for an Android project:

    - -
      -
    1. Open Edit Configurations from the Run Menu.
    2. - -
    3. Expand the Android Application item and create a new configuration or open - an existing one.
    4. - -
    5. With the Run Configuration selected, adjust your desired run configuration settings: -
        -
      • In the General tab, specify the Module settings to launch. In Target tab, consider whether - you'd like to use Manual or Automatic mode when selecting an AVD to run your application. See - the following section on Automatic and manual target modes). +
      • Expand the Android Application item and select an + existing run configuration. +
          +
        • To create a new run configuration, click the '+' + button in the top left corner of the dialog box and select + Android Application.
        • -
        • In the Emulator tab, specify any emulator options to the Additional Emulator Command Line - Options field. For example, you could add -scale 96dpi to scale the AVD's screen - to an accurate size, based on the dpi of your computer monitor. For a full list of emulator - options, see the Android - Emulator document.

          -
        • -
        • In the Logcat tab, set the LogCat options for the application.
        • -
        -
      • -
    + + +
  3. With a run configuration selected, adjust your desired settings. For + example, in the General tab, you can specify the APK + installation settings, launch options, and deployment target options. +
  4. +
-

Automatic and manual target modes

+

+ Changing the build variant +

-

By default, a run configuration uses the automatic target mode in order to - select an AVD. In this mode, Android Studio will select an AVD for the application in the following - manner:

+

+ By default, Android Studio builds the debug version of your app, which is + intended only for testing, when you click Run 'app'. You + need to build the release version when preparing your app for public + release. +

+

+ To change the build variant Android Studio uses, go to Build + > Select Build Variant and select a different one from + the drop-down menu. By default, new projects are set up with a debug and + release build variant. +

-
    -
  1. If there's a device or emulator already running and its AVD configuration meets the - requirements of the application's build target, the application is installed and run upon - it.
  2. +

    + Using product flavors, you can create additional build variants for + different versions of your app, each having different features or device + requirements. To learn more about build variants and product flavors, read + Configuring Gradle + Builds. +

    -
  3. If there's more than one device or emulator running, each of which meets the requirements - of the build target, a device chooser is shown to let you select which device to use.
  4. +

    + Monitoring the build process +

    -
  5. If there are no devices or emulators running that meet the requirements of the build - target, Android Studio looks at the available AVDs. If there is an AVD that matches the build - target of the project, Android Studio chooses that AVD. If the AVD versions are newer than the - build target of the project, Android Studio chooses the oldest possible version of an AVD that - meets the project or module build target requirement.
  6. +

    + You can view details about the build process by clicking Gradle + Console . The console displays each + task that Gradle executes in order to build your app, as shown in figure 1. +

    -
  7. If there are no suitable AVDs, the application is not installed and a console error warning - tells you that there is no existing AVD that meets the build target requirements.
  8. -
+ +

+ Figure 1. The Gradle Console in Android Studio. +

-

However, if a "preferred" AVD is selected in the run configuration, then the application will - always be deployed to that AVD. If it's not already running, then a new emulator will be - launched.

+

+ If your build variants use product flavors, Gradle also invokes tasks to + build those product flavors. To view the list of all available build tasks, + click Gradle on the right side of the IDE + window. +

-

If your run configuration uses manual mode, then the "device chooser" is - presented every time that your application is run, so that you can select which AVD to use.

+

+ If an error occurs during the build process, the Messages window + will appear to describe the issue. +

+

+ Generating APKs +

+

+ When you click Run 'app', Android Studio generates a debug + APK and deploys it to your target device. Before you can generate a release + version of your app for public distribution, however, you must first learn + how to sign your + app. You can then generate multiple signed APKs of your debug or release + build variants. To locate the generated APK files, click the link in the + pop-up dialog, as shown in figure 2. +

-

Running on the emulator

- -

Before you can run your application on the Android Emulator, you verify the default AVD or - create an AVD.

- -

To run (or debug) your application, select Run > Run (or - Run > debug) from the Android Studio menu bar. Android Studio - automatically creates a default run configuration for the project. Android Studio will then perform - the following:

- -
    -
  1. Compile the project (if there have been changes since the last build).
  2. - -
  3. Create a default run configuration (if one does not already exist for the project).
  4. - -
  5. Install and start the application on an emulator (or device), based on the Deployment - Target defined by the run configuration. - -

    By default, Android run configurations use an "automatic target" mode for selecting a - device target. For information on how automatic target mode selects a deployment target, see - Automatic and manual target modes above.

    -
  6. -
- -

If you run the application with Debug, the Choose a Device option - appears so you can select an attached device or emulator. Once the device or emulator is selected, - Android Studio opens the Debug console and starts the application's main activity. Otherwise, if - you run the application with the normal Run command, Android Studio installs the application on the - device and launches the main activity.

- -

To set or change the run configuration used for your project or module, select - Run > Edit Configurations. See the section below about - Creating a Run Configuration for more information.

- -

Be certain to create multiple AVDs upon which to test your application. You should have one - AVD for each platform and screen type with which your application is compatible. For instance, if - your application compiles against the Android 4.0 (API Level 14) platform, you should create an - AVD for each platform equal to and greater than 4.0 and an AVD for each screen type you support, then test your - application on each one.

- -

Running on a device

- -

Before you can run your application on a device, you must perform some basic setup for your - device:

- - - -

Read Using Hardware Devices - for more information.

- -

Once set up and your device is connected via USB, install your application on the device by - selecting Run > Run (or Run > - Debug) from the Android Studio menu bar.

- +

+ +

+

+ Figure 2. Click the link to locate the generated APK + files. +

\ No newline at end of file diff --git a/docs/html/tools/publishing/app-signing.jd b/docs/html/tools/publishing/app-signing.jd index 8f68ff72e6127..4b74f5ff81393 100644 --- a/docs/html/tools/publishing/app-signing.jd +++ b/docs/html/tools/publishing/app-signing.jd @@ -175,11 +175,23 @@ enter the passwords for both. Then click Next.

width="349" height="232" style="margin-top:15px"/>

Figure 2. Select a private key in Android Studio.

-
  • On the next window, select a destination for the signed APK and click -Finish.

    +
  • + On the next window, select a destination for the signed APK(s), select the + build type, (if applicable) choose the product flavor(s), and click + Finish.

    -

    Figure 3. Generate a signed APK in Android Studio.

    +

    + Figure 3. Generate signed APKs for the selected product + flavors. +

    +

    + Note: If your project uses product flavors, you can select + multiple product flavors while holding down the Ctrl key on + Windown/Linux, or the Command key on Mac OSX. Android Studio + will generate a separate APK for each selected product flavor. +

    +