page.title=Set Up the Preview SDK page.image=images/cards/card-set-up_16-9_2x.png @jd:body

In this document

  1. Get the Preview SDK
  2. Create or Update a Project
  3. Set Up for Testing

The Preview SDK is available from the Android SDK Manager. This document assumes that you are familiar with Android app development, such as using the Android SDK Manager and creating projects. If you are new to Android, see Building Your First App training lesson first.

Get the Preview SDK

To add the Android Preview SDK components to your development environment:

  1. Start the Android SDK Manager.
  2. In the Tools section, select the latest Android SDK Tools, Platform-tools, and Build-tools.
  3. Select everything under the Android M Developer Preview section and click Install packages...
  4. Accept the Licensing Agreement for all of the packages and click Install.

After completing these steps, the preview components are available in your development environment.

Create or Update a Project

In order to use the preview APIs, you must create or update a development project to use the preview components.

Create a new project

We recommend using Android Studio for create a project with the preview. Follow the steps described in Creating a Project until you arrive at the Form Factors screen in the project wizard. Then perform the following steps to create a project configured for the preview.

Update an existing project

For existing projects, you must modify the project configuration to enable the preview APIs. In your the development environment, open the build.gradle file for your module and set these values as follows:

Set Up for Testing

Testing app with the preview requires that you have a device or virtual device configured with the preview version of the platform. If you have a compatible device, you can install the preview platform for testing. Otherwise, you can configure a virtual device for testing.

Set up a Physical Device

If you have a Nexus 5, Nexus 6, Nexus 9, or Nexus Player, you can install a preview system image on these devices for testing your app. You can set up virtual device with the preview version of the platform from within Android Studio using the Android Virtual Device Manager tool.

Important: Installing a preview image on a device removes all data from it, so you should backup any data before installing a preview image.

Set up a Virtual Device

You can set up virtual device with the preview version of the platform from within Android Studio using the Android Virtual Device Manager tool.

To create an AVD with the AVD Manager:

  1. Install the M Preview SDK in your development environment, as described in Setting Up the Preview SDK.
  2. Follow the steps in Managing AVDs with AVD Manager. Use the following settings:

For more information about creating virtual devices for testing, see Managing Virtual Devices.