diff options
Diffstat (limited to 'docs/html/sdk/installing.jd')
| -rw-r--r-- | docs/html/sdk/installing.jd | 153 |
1 files changed, 86 insertions, 67 deletions
diff --git a/docs/html/sdk/installing.jd b/docs/html/sdk/installing.jd index 73190a0..8484bea 100644 --- a/docs/html/sdk/installing.jd +++ b/docs/html/sdk/installing.jd @@ -29,20 +29,20 @@ sdk.preview=0 </div> </div> -<p>This page describes how to install the Android SDK +<p>This page describes how to install the Android SDK and set up your development environment for the first time.</p> -<p>If you encounter any problems during installation, see the +<p>If you encounter any problems during installation, see the <a href="#troubleshooting">Troubleshooting</a> section at the bottom of this page.</p> <h4>Updating?</h4> -<p>If you are currently using the Android 1.6 SDK or later and want to update -to the latest tools or platforms, you do not need to install a new SDK. Instead, -you can simply update the individual components in your SDK using the -Android SDK and AVD Manager tool. For information about how to do that, see <a -href="{@docRoot}sdk/adding-components.html#UpdatingComponents">Updating SDK +<p>If you are currently using the Android 1.6 SDK or later and want to update +to the latest tools or platforms, you do not need to install a new SDK. Instead, +you can simply update the individual components in your SDK using the +Android SDK and AVD Manager tool. For information about how to do that, see <a +href="{@docRoot}sdk/adding-components.html#UpdatingComponents">Updating SDK Components</a></p> <p>If you are using Android 1.5 SDK or earlier, you should install a new SDK as @@ -54,65 +54,71 @@ SDK environment. </p> <p>Before getting started with the Android SDK, take a moment to confirm that your development computer meets the <a href="requirements.html">System -Requirements</a>. In particular, you may need to install the <a -href="http://java.sun.com/javase/downloads/index.jsp">JDK</a> before +Requirements</a>. In particular, you may need to install the <a +href="http://java.sun.com/javase/downloads/index.jsp">JDK</a> before continuing, if it's not already installed on your computer. </p> <p>If you will be developing in Eclipse with the Android Development Tools (ADT) Plugin — the recommended path if you are new to Android — make sure that you have a suitable version of Eclipse -installed on your computer (3.4 or newer is recommended). If you need -to install Eclipse, you can download it from this location: </p> - +installed on your computer (3.4 or newer is recommended). If you need +to install Eclipse, you can download it from this location: </p> + <p style="margin-left:2em;"><a href= -"http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a></p> - -<p>A Java or RCP version of Eclipse is recommended. For Eclipse 3.5, the -"Eclipse Classic" version is recommended.</p> +"http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a></p> + +<p>A Java or RCP version of Eclipse is recommended. For Eclipse 3.5, the +"Eclipse Classic" version is recommended.</p> <h2 id="Installing">Step 2. Downloading the SDK Starter Package</h2> <p>The first step in setting up your environment for developing Android applications is downloading the Android SDK starter package. The starter package is not a full -development environment — it includes only the core SDK Tools, which you can -use to download the rest of the SDK components. </p> +development environment — it includes only the core SDK Tools, which you can +use to download the rest of the SDK components (such as the platform system images). </p> <p>You can get the latest version of the SDK starter package from the <a href="{@docRoot}sdk/index.html">SDK download page</a>. Make sure to download the package that is appropriate for your development computer.</p> -<p>After downloading, unpack the Android SDK archive to a safe location on your -machine. By default, the SDK files are unpacked into a directory named -<code>android-sdk-<machine-platform></code>. Make a note of the name and +<p class="note"><strong>Note:</strong> If you're using Windows, we recommend that you download +the SDK installer (the {@code .exe} file from the download table). It will guide you through the +installation process and check your computer for the required software.</p> + +<p>If you downloaded a {@code .zip} of {@code .tgz} (instead of using the SDK installer), unpack the +Android SDK archive to a safe location on your machine. By default, the SDK files are unpacked into +a directory named <code>android-sdk-<machine-platform></code>.</p> + +<p>Make a note of the name and location of the unpacked SDK directory on your system — you will need to -refer to the SDK directory later, when setting up the ADT plugin or when using -the SDK tools.</p> - -<p>Optionally, you may want to add the location of the SDK's primary -<code>tools</code> directory to your system <code>PATH</code>. The primary -<code>tools/</code> directory is located at the root of the SDK folder. Adding -<code>tools</code> to your path lets you run Android Debug Bridge (adb) and the -other command line <a +refer to the SDK directory later, when setting up the ADT plugin and when using +the SDK tools from command line.</p> + +<p>Optionally, you might want to add the location of the SDK's primary +<code>tools</code> directory and the additional {@code platform-tools/} directory to your system +<code>PATH</code>. Both tool directories are located at the root of the SDK folder. Adding +<code>tools/</code> and {@code platform-tools/} to your path lets you run Android Debug Bridge (adb) +and the other command line <a href="{@docRoot}guide/developing/tools/index.html">tools</a> without needing to -supply the full path to the tools directory. </p> +supply the full path to the tool directories. </p> <ul> <li>On Linux, edit your <code>~/.bash_profile</code> or <code>~/.bashrc</code> file. Look for a line that sets the PATH environment variable and add the - full path to the <code>tools/</code> directory to it. If you don't + full path to the <code>tools/</code> and {@code platform-tools/} directories to it. If you don't see a line setting the path, you can add one:</li> - <ul><code>export PATH=${PATH}:<em><your_sdk_dir></em>/tools</code></ul> + <ul><code>export PATH=${PATH}:<your_sdk_dir>/tools:<your_sdk_dir>/platform-tools</code></ul> <li>On a Mac OS X, look in your home directory for <code>.bash_profile</code> and - proceed as for Linux. You can create the <code>.bash_profile</code> if + proceed as for Linux. You can create the <code>.bash_profile</code> if you haven't already set one up on your machine. </li> - <li>On Windows, right-click on My Computer, and select Properties. + <li>On Windows, right-click on My Computer, and select Properties. Under the Advanced tab, hit the Environment Variables button, and in the - dialog that comes up, double-click on Path (under System Variables). Add the full path to the - <code>tools/</code> directory to the path. </li> + dialog that comes up, double-click on Path (under System Variables). Add the full path to the + <code>tools/</code> and {@code platform-tools/} directories to the path. </li> </ul> <p>If you will be using the Eclipse IDE as your development environment, the @@ -203,11 +209,11 @@ access to powerful mapping capabilities through the <code>com.google.android.maps</code> library. You can also add additional repositories, so that you can download other SDK add-ons, where available. </li> -<li><strong>USB Driver for Windows</strong> — Contains driver files +<li><strong>USB Driver for Windows</strong> — Contains driver files that you can install on your Windows computer, so that you can run and debug your applications on an actual device. You <em>do not</em> need the USB driver unless you plan to debug your application on an actual Android-powered device. If you -develop on Mac OS X or Linux, you do not need a special driver to debug +develop on Mac OS X or Linux, you do not need a special driver to debug your application on an Android-powered device.</li> <li><strong>Samples</strong> — Contains the sample code and apps available @@ -226,15 +232,15 @@ Manager, shown in Figure 1, to browse the SDK repository, select new or updated components for download, and then install the selected components in your SDK environment. </p> -<div style="TEXT-ALIGN:left;width:600px;"> -<img src="/images/sdk_manager_packages.png" -style="padding-bottom:0;margin-bottom:0;" /> +<div style="TEXT-ALIGN:left;width:600px;"> +<img src="/images/sdk_manager_packages.png" +style="padding-bottom:0;margin-bottom:0;" /> <p class="caption" style="margin:0 0 1.5em 1em;padding:0 0 0 -1em;"><strong>Figure 1.</strong> The Android SDK and AVD Manager's +1em;"><strong>Figure 1.</strong> The Android SDK and AVD Manager's <strong>Available Packages</strong> panel, which shows the SDK components that are available for you to download into your environment. </p> -</div> +</div> <h3 id="which">Which components do I need?</h3> @@ -257,8 +263,8 @@ recommended or full development environment: </p> <td style="font-size:.9em;background-color:#FFE;color:gray">SDK Tools</td> <td style="font-size:.9em;background-color:#FFE;color:gray">If you've installed the SDK starter package, then you already have this component preinstalled. The -SDK Tools component is required — you can't develop or build an application -without it. </td> +SDK Tools and the SDK Platform-tools components are required — you can't develop or build an +application without these. Make sure you keep these up to date.</td> </tr> <tr> @@ -324,8 +330,8 @@ applications on different platforms by running in an Android Virtual Device to add components, see the <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a> document. </p> -<p>For revision notes and other detailed information about individual SDK -components, see the documents listed under "Downloadable SDK Components" in +<p>For revision notes and other detailed information about individual SDK +components, see the documents listed under "Downloadable SDK Components" in the navigation at left.</p> @@ -335,7 +341,7 @@ the navigation at left.</p> and add-ons that you need, open the SDK directory and take a look at what's inside.</p> -<p>The table below describes the full SDK directory contents, with components +<p>The table below describes the full SDK directory contents, with components installed. </p> <table> @@ -351,10 +357,19 @@ devices. </td> <tr> <td colspan="3"><code>docs/</code></td> <td>A full set of documentation in HTML format, including the Developer's Guide, -API Reference, and other information. To read the documentation, load the +API Reference, and other information. To read the documentation, load the file <code>offline.html</code> in a web browser.</td> </tr> <tr> +<td colspan="3"><code>platform-tools/</code></td> +<td>Contains development tools that may be updated with each platform release (from the <em>Android +SDK Platform-tools</em> component). Tools in here include {@code adb}, {@code dexdump}, and others +others that you don't typically use directly. These tools are separate from the generic development +tools in the {@code tools/} directory, because these tools may be updated in order to support new +features in the latest Android platform, whereas the other tools have no dependencies on the +platform version.</td> +</tr> +<tr> <td colspan="3"><code>platforms/</code></td> <td>Contains a set of Android platform versions that you can develop applications against, each in a separate directory. </td> @@ -362,7 +377,7 @@ applications against, each in a separate directory. </td> <tr> <td style="width:2em;border-bottom-color:white;"></td> <td colspan="2"><code><em><platform></em>/</code></td> -<td>Platform version directory, for example "android-1.6". All platform version +<td>Platform version directory, for example "android-1.6". All platform version directories contain a similar set of files and subdirectory structure.</td> </tr> @@ -376,8 +391,8 @@ directories contain a similar set of files and subdirectory structure.</td> <td style="width:2em;border-bottom-color:white;"></td> <td style="width:2em;border-bottom-color:white;"></td> <td><code>images/</code></td> -<td>Storage area for default disk images, including the Android system image, -the default userdata image, the default ramdisk image, and more. The images +<td>Storage area for default disk images, including the Android system image, +the default userdata image, the default ramdisk image, and more. The images are used in emulator sessions.</td> </tr> <tr> @@ -397,7 +412,8 @@ designed for a specific screen resolution.</td> <td style="width:2em;border-bottom-color:white;"></td> <td style="width:2em;border-bottom-color:white;"></td> <td><code>tools/</code></td> -<td>Any development tools that are specific to the platform version.</td> +<td>This directory is used only by SDK Tools r7 and below for development tools that are specific to +this platform version—it's not used by SDK Tools r8 and above.</td> </tr> <tr> <td style="width:2em;"></td> @@ -411,18 +427,21 @@ version.</td> <td>Sample code and apps that are specific to platform version.</td> </tr> <td colspan="3"><code>tools/</code></td> -<td>Contains the set of development and profiling tools available to you, such -as the emulator, the <code>android</code> tool, adb, ddms, and more.</td> +<td>Contains the set of development and profiling tools that are platform-independent, such +as the emulator, the AVD and SDK Manager, adb, ddms, hierarchyviewer and more. The tools in +this directory may be updated at any time (from the <em>Android SDK Tools</em> component), +independent of platform releases, whereas the tools in {@code platform-tools/} may be updated based +on the latest platform release.</td> </tr> <tr> <td colspan="3"><code>SDK Readme.txt</code></td> -<td>A file that explains how to perform the initial setup of your SDK, -including how to launch the Android SDK and AVD Manager tool on all +<td>A file that explains how to perform the initial setup of your SDK, +including how to launch the Android SDK and AVD Manager tool on all platforms</td> </tr> <tr> -<td colspan="3"><code>SDK Setup.exe</code></td> -<td>Windows SDK only. A shortcut that launches the Android SDK and AVD +<td colspan="3"><code>SDK Manager.exe</code></td> +<td>Windows SDK only. A shortcut that launches the Android SDK and AVD Manager tool, which you use to add components to your SDK. </td> </tr> <!--<tr> @@ -447,7 +466,7 @@ begin developing applications. Here are a few ways you can get started: </p> </li> </ul> -<p class="caution">Following the Hello World tutorial is an essential +<p class="caution">Following the Hello World tutorial is an essential first step in getting started with Android development. </p> <p><strong>Learn about Android</strong></p> @@ -481,20 +500,20 @@ Android-powered device to run and test your application.</li> <ul> <li>The <a href="{@docRoot}resources/tutorials/notepad/index.html"> - Notepad Tutorial</a> shows you how to build a full Android application - and provides helpful commentary on the Android system and API. The + Notepad Tutorial</a> shows you how to build a full Android application + and provides helpful commentary on the Android system and API. The Notepad tutorial helps you bring together the important design - and architectural concepts in a moderately complex application. + and architectural concepts in a moderately complex application. </li> </ul> -<p class="caution">Following the Notepad tutorial is an excellent +<p class="caution">Following the Notepad tutorial is an excellent second step in getting started with Android development. </p> <p><strong>Explore some code</strong></p> <ul> <li>The Android SDK includes sample code and applications for each platform -version. You can browse the samples in the <a +version. You can browse the samples in the <a href="{@docRoot}resources/index.html">Resources</a> tab or download them into your SDK using the Android SDK and AVD Manager. Once you've downloaded the samples, you'll find them in @@ -517,7 +536,7 @@ samples, you'll find them in <ul> <li>If you need help installing and configuring Java on your - development machine, you might find these resources helpful: + development machine, you might find these resources helpful: <ul> <li><a href="https://help.ubuntu.com/community/Java">https://help.ubuntu.com/community/Java </a></li> <li><a href="https://help.ubuntu.com/community/Java">https://help.ubuntu.com/community/JavaInstallation</a></li> @@ -537,7 +556,7 @@ samples, you'll find them in eclipse.org (<a href="http://www.eclipse.org/downloads/">http://www.eclipse.org/ downloads/</a>). A Java or RCP version of Eclipse is recommended.</li> - <li>Follow the steps given in previous sections to install the SDK + <li>Follow the steps given in previous sections to install the SDK and the ADT plugin. </li> </ol> </li> |