Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Android N Preview Setup page

Browse Source 
Change-Id: I2f3bdd98119d8d1bb8b064bd2a908d1e38997ea2
This commit is contained in:
Joe Fernandez
2016-03-02 21:30:31 -08:00
parent abfcd9fe83
commit 7f94b7e9db
1 changed files with 180 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

272
docs/html/preview/setup-sdk.jd
View File

@@ -1,4 +1,4 @@
page.title=Set Up the SDK
page.title=Set Up the Preview SDK
page.image=images/cards/card-set-up_16-9_2x.png
@jd:body
@@ -8,166 +8,254 @@ page.image=images/cards/card-set-up_16-9_2x.png
<div id="qv">
<h2>In this document</h2>
<ol>
<li><a href="#get-as13">Get Android Studio 1.3</a></li>
<li><a href="#get-sdk">Get the Android 6.0 SDK</a></li>
<li><a href="#get-as13">Get Android Studio 2.1</a></li>
<li><a href="#get-sdk">Get the Preview SDK</a></li>
<li><a href="#java8">Get the Java 8 JDK</a></li>
<li><a href="#create-update">Create or Update a Project</a></li>
<li><a href="#setup-test">Set Up for Testing</a></li>
</ol>
</div>
</div>
<p>With Developer Preview 3, the <strong>official Android 6.0 SDK is now available</strong> 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 <a href="{@docRoot}training/basics/firstapp/index.html">Building Your First
App</a> training lesson first.</p>
<h2 id="get-as13">Get Android Studio 1.3</h2>
<p>
You must have a development enviroment to make use of the Android N Developer
Preview. This document describes how to setup and configure a development
environment so you can use and test the Preview SDK.
</p>
<p>
It is highly recommended that you install the Android Studio 1.3 to work best with
the Android 6.0 SDK. Please update your Android Studio installation to version 1.3 or
higher, or follow the instructions for
<a href="{@docRoot}sdk/installing/index.html?pkg=studio">Installing Android Studio</a>.
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
<a href="{@docRoot}training/basics/firstapp/index.html">Building Your First
App</a> training lesson first.
</p>
<h2 id="get-sdk">Get the Android 6.0 SDK</h2>
<h2 id="get-as13">Get Android Studio 2.1</h2>
<p>To add the Android 6.0 SDK components to your development environment:</p>
<p>
The Developer Preview is best used with Android Studio 2.1, which is also in
preview status. If you have an existing version of Android Studio you are
using for development, you should install a separate instance of Android
Studio for use with the Preview. This section describes how to install
an instance of Android Studio and update to version 2.1.
</p>
<p class="caution">
<strong>Caution:</strong> The canary preview of Android Studio 2.1 is still
in active development. If you are using your primary development machine to
test the developer preview, you should create a second installation of
Android Studio to use for testing the Developer Preview.
</p>
<p>To install Android Studio and update to version 2.1:</p>
<ol>
<li>Launch Android Studio 1.3 or higher.
<li>Download, install, and launch the current version of
<a href="{@docRoot}tools/studio/index.html">Android Studio</a>.
</li>
<li>Open the <strong>Settings</strong> window (on Windows, you can do this
by choosing <strong>File &gt; Settings</strong>). Choose the
<strong>Appearance &amp; Behavior &gt; System
Settings &gt; Updates</strong> panel.
<p class="aside">On Mac OS X, you can find the <strong>Appearance &amp;
Behavior</strong> panel
in Android Studio's <strong>Preferences</strong> window.</p>
<li>In Android Studio, open the <em>Settings</em> dialog and in the left
panel, choose <strong>Appearance &amp; Behavior &gt; System Settings &gt;
Updates</strong>.
<ul>
<li>On Windows and Linux, open <em>Settings</em> by choosing
<strong>File &gt; Settings</strong>.
</li>
<li>On Mac OS, open <em>Settings</em> by choosing
<strong>Android Studio &gt; Preferences</strong>.
</li>
</ul>
</li>
<li>On the <strong>Updates</strong> panel, choose the option for
<strong>Automatically check updates for Android SDK: Preview Channel</strong>.
<li>On the <em>Updates</em> panel, make sure the <strong>Automatically
check updates for</strong> option is selected and choose the
<strong>Canary Channel</strong> option.
</li>
<li>Launch the <strong>Android SDK Manager</strong>. (With Android Studio 1.3,
the SDK Manager is integrated into Android Studio instead of being a
standalone application.)
</li>
<li>Under the <strong>Platforms</strong> section, select <strong>Android 6.0</strong>.
</li>
<li>In the <strong>Tools</strong> section, select the latest Android <strong>
SDK Tools</strong>, <strong>Platform-tools</strong>, and
<strong>Build-tools</strong>.
</li>
<li>Click <strong>Install packages</strong> and accept the licensing
agreement for all of the packages.
</li>
<li>Verify that the Android 6.0 SDK is installed by opening the <strong>
Settings</strong> window and choosing the <strong>Appearance &amp; Behavior
&gt; System Settings &gt; Android SDK</strong> panel.</li>
<li>On the <strong>Android SDK</strong> panel, choose
the <strong>SDK Platforms</strong> tab. <strong>Android 6.0</strong> should be listed as <em>Installed</em>. Also, open the
<strong>SDK Tools</strong> tab to verify that the latest tools are
installed.
<li>On the <em>Updates</em> panel, click <strong>Check Now</strong>
to check for the latest canary build. Allow the software to download
and install the canary version when prompted.
</li>
</ol>
<p>After completing these steps, the preview components are available in your development
environment. </p>
<h2 id="java8">Get the Java 8 JDK</h2>
<p>
You must use the Java 8 Development Kit with the N Developer Preview. If you
do not have this version of the JDK installed, download and install it before
working with the Preview SDK.
</p>
<p>To set the JDK version in Android Studio:</p>
<ul>
<li>Make sure you have installed the Java 8 JDK, and make a note of its
directory location on your development computer.</li>
<li>With a development project open in Android Studio, open the
<em>Project Structure</em> dialog by choosing <strong>File &gt;
Project Structure</strong>.
</li>
<li>In the left panel of the dialog, click <strong>SDK Location</strong>.
</li>
<li>In the <strong>JDK Location</strong> field, enter the location of the
Java 8 JDK, and click <strong>OK</strong>.
</li>
</ul>
<h2 id="get-sdk">Get the Preview SDK</h2>
<p>To add the Preview SDK to your Android Studio 2.1 development
environment:</p>
<ol>
<li>Launch Android Studio 2.1.
</li>
<li>In Android Studio, open the <em>Settings</em> dialog and in the left
panel, choose <strong>Appearance &amp; Behavior &gt; System Settings &gt;
Updates</strong>.
<ul>
<li>On Windows and Linux, open <em>Settings</em> by choosing
<strong>File &gt; Settings</strong>.
</li>
<li>On Mac OS, open <em>Settings</em> by choosing
<strong>Android Studio &gt; Preferences</strong>.
</li>
</ul>
</li>
<li>On the <em>Updates</em> panel, make sure the <strong>Automatically
check updates for Android SDK</strong> option is selected and choose the
<strong>Preview Channel</strong> option.
</li>
<li>In the <em>Settings</em> dialog left panel, choose
<strong>Appearance &amp; Behavior &gt; System Settings &gt;
Android SDK</strong>.
</li>
<li>Click the <strong>SDK Platforms</strong> button, and then select
<strong>Android N Preview</strong>.
</li>
<li>Click the <strong>SDK Tools</strong> button, and select the latest
Android <strong>SDK Tools</strong>, <strong>Platform-tools</strong>, and
<strong>Build-tools</strong> versions.
</li>
<li>Click <strong>OK</strong> and then accept the licensing
agreements for the packages to be installed.
</li>
</ol>
<p>After completing these steps, the preview components are available in your
development environment. </p>
<h2 id="create-update">Create or Update a Project</h2>
<p>
In order to use the preview APIs, you must create or update a development project to use
the preview components.
In order to use the preview APIs, you must create or update a development
project to use the preview components.
</p>
<h3 id="create">Create a new project</h3>
<p>
We recommend using Android Studio to create a project with the preview. Follow the steps
described in <a href="{@docRoot}sdk/installing/create-project.html">Creating a Project</a>
until you arrive at the <em>Form Factors</em> screen in the project wizard. Then perform
the following steps to create a project configured for the preview.
Use the Android Studio new project wizard to create a project. For detailed
information on how to create a project with this too, see
<a href="{@docRoot}sdk/installing/create-project.html">Creating a Project</a>.
</p>
<ul>
<li>Check <strong>Phone and Tablet</strong>.</li>
<li>Select <strong>API 23: Android 6.0 (Marshmallow)</strong> in <strong>Minimum
SDK</strong>.</li>
</ul>
<p>To create a new project using the Preview SDK:</p>
<ol>
<li>Start the New Project wizard and follow the steps until you reach the
<em>Target Android Devices</em> page.
</li>
<li>On this page, select <strong>Phone and Tablet</strong> option.</li>
<li>Under <strong>Phone and Tablet</strong> option, in the <strong>Minimum
SDK</strong> option list, select <strong>Android N Preview</strong>.</li>
</ol>
<h3 id="update">Update an existing project</h3>
<p>
For existing projects, if you are using Android 6.0 APIs (API level 23) you must
modify the project configuration. In your development environment, open the
<code>build.gradle</code> file for your module and
set these values as follows:
For existing projects, you must modify the project configuration to use the
Preview APIs. In your development environment, open the
<code>build.gradle</code> file for your module and set these values as
follows:
</p>
<ul>
<li><code>compileSdkVersion</code> is set to <code>'23'</code></li>
<li><code>targetSdkVersion</code> is set to <code>'23'</code></li>
</ul>
<pre>
android {
compileSdkVersion <strong>'android-N'</strong>
...
defaultConfig {
...
minSdkVersion <strong>'N'</strong>
targetSdkVersion <strong>'N'</strong>
...
}
...
}</pre>
<h2 id="setup-test">Set Up for Testing</h2>
<p>
Testing an 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.
Testing an 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.
</p>
<h3 id="setup-device">Set up a physical device</h3>
<p>
If you have a Nexus 5, Nexus 6, Nexus 9, or Android TV, you can install a preview
system image on these devices for testing your app.
You can set up a virtual device with the preview version of the platform from within Android Studio
using the Android Virtual Device Manager tool.
If you have a Nexus 5X, Nexus 6P, Nexus 9, or Nexus Player, you can install a
preview system image on these devices for testing your app. You can set up a
virtual device with the preview version of the platform from within Android
Studio using the Android Virtual Device Manager tool.
</p>
<p class="caution">
<strong>Important:</strong> Installing a preview image on a device <em>removes all data from
it</em>, so you should backup any data before installing a preview image.
<strong>Important:</strong> Installing a preview image on a device
<em>removes all data from it</em>, so you should backup any data before
installing a preview image.
</p>
<h3 id="setupAVD">Set up a virtual device</h3>
<p>
You can set up virtual device with the preview version of the platform from within Android Studio
using the Android Virtual Device Manager tool.
You can set up virtual device with the preview version of the platform from
within Android Studio using the Android Virtual Device Manager tool.
</p>
<p>To create an AVD with the AVD Manager:</p>
<ol>
<li>Install the Preview SDK in your development environment, as described
in <a href="{@docRoot}preview/setup-sdk.html">Setting Up the Preview
SDK.</a></li>
in <a href="{@docRoot}preview/setup-sdk.html">Setting Up the Preview
SDK.</a></li>
<li>Follow the steps in
<a href="{@docRoot}tools/devices/managing-avds.html">Managing AVDs with AVD
Manager</a>. Use the following settings:
<a href="{@docRoot}tools/devices/managing-avds.html">Managing AVDs with AVD
Manager</a>. Use the following settings:
<ul>
<li><strong>Device:</strong> Nexus 5, Nexus 6, Nexus 9, or Android TV</li>
<li><strong>Device:</strong>
Nexus 5X, Nexus 6P, Nexus 9, or Android TV</li>
<li><strong>Target:</strong>
Android M (Preview) - API Level M</li>
<li><strong>ABI:</strong> x86</li>
Android N (Preview) - API Level N</li>
<li><strong>ABI:</strong>
x86</li>
</ul>
</li>
</ol>