diff --git a/docs/html/sdk/adding-components.jd b/docs/html/sdk/adding-components.jd index 63c577ea75b3c..755f200fa641c 100644 --- a/docs/html/sdk/adding-components.jd +++ b/docs/html/sdk/adding-components.jd @@ -6,7 +6,7 @@ page.title=Adding SDK Components
Adding and updating components in your Android SDK is fast and easy. To perform an update, use the Android SDK and AVD Manager to install or update the individual SDK components that you need. The Android SDK -and AVD Manager tool is included in the Android SDK +and AVD Manager tool is included in the Android SDK download.
It only takes a couple of clicks to install individual versions of the @@ -53,19 +53,19 @@ a new version of the platform. See the revisions listed in the SDK Tools document for ADT Plugin compatibility.
-
+
Figure 1. The Android SDK and AVD Manager's +1em;">Figure 1. The Android SDK and AVD Manager's Available Packages panel, which shows the SDK components that are available for you to download into your environment.
-The Android SDK and AVD Manager is the tool that you use to install and +
The Android SDK and AVD Manager is the tool that you use to install and upgrade SDK components in your development environment.
You can access the tool in any of three ways:
@@ -83,15 +83,15 @@ follow these steps to access the Android SDK and AVD Manager tool:For Windows only, the SDK includes a script that invokes the Android SDK and -AVD Manager. To launch the tool using the script, double-click "SDK -Setup.exe" at the root of the the SDK directory.
+AVD Manager. To launch the tool using the script, double-click {@code SDK +Manager.exe} at the root of the the SDK directory.<sdk>/tools/ directory.$ android
Important: Before you install SDK components, -we recommend that you disable any antivirus programs that may be running on -your computer.
+Caution: Before you install SDK components, +we recommend that you disable any antivirus software that may be running on +your computer. There are cases in which antivirus software on Windows is known to interfere with the +installation process, so we suggest you disable your antivirus until installation is +complete.
Follow these steps to install new SDK components in your environment:
New platforms are automatically saved into the +
New platforms are automatically saved into the
<sdk>/platforms/ directory of your SDK;
new add-ons are saved in the <sdk>/add-ons/
-directory; samples are saved in the
-<sdk>/samples/android-<level>/;
+directory; samples are saved in the
+<sdk>/samples/android-<level>/;
and new documentation is saved in the existing
<sdk>/docs/ directory (old docs are replaced).
By default, Available Packages only shows the default -repository site, which offers platforms, SDK tools, documentation, the -Google APIs Add-on, and other components. You can add other sites that host +repository site, which offers platforms, SDK tools, documentation, the +Google APIs Add-on, and other components. You can add other sites that host their own Android SDK add-ons, then download the SDK add-ons -from those sites.
+from those sites.For example, a mobile carrier or device manufacturer might offer additional API libraries that are supported by their own Android-powered devices. In order @@ -199,7 +201,7 @@ Manager:
Any SDK components available from the site will now be listed under diff --git a/docs/html/sdk/index.jd b/docs/html/sdk/index.jd index 7016eeebf1030..2e59801c1b360 100644 --- a/docs/html/sdk/index.jd +++ b/docs/html/sdk/index.jd @@ -1,27 +1,27 @@ page.title=Android SDK sdk.redirect=0 -sdk.win_download=android-sdk_r07-windows.zip -sdk.win_bytes=23669664 -sdk.win_checksum=69c40c2d2e408b623156934f9ae574f0 +sdk.win_installer=installer_r08-windows.exe +sdk.win_installer_bytes=TODO +sdk.win_installer_checksum=TODO -sdk.mac_download=android-sdk_r07-mac_x86.zip -sdk.mac_bytes=19229546 -sdk.mac_checksum=0f330ed3ebb36786faf6dc72b8acf819 +sdk.win_download=android-sdk_r08-windows.zip +sdk.win_bytes=TODO +sdk.win_checksum=TODO -sdk.linux_download=android-sdk_r07-linux_x86.tgz -sdk.linux_bytes=17114517 -sdk.linux_checksum=e10c75da3d1aa147ddd4a5c58bfc3646 +sdk.mac_download=android-sdk_r08-mac_x86.zip +sdk.mac_bytes=TODO +sdk.mac_checksum=TODO + +sdk.linux_download=android-sdk_r08-linux_x86.tgz +sdk.linux_bytes=TODO +sdk.linux_checksum=TODO @jd:body
The steps below provide an overview of how to get started with the Android -SDK. For detailed instructions, start with the Installing the SDK guide.
-1. Prepare your development computer
Read the System Requirements @@ -34,38 +34,37 @@ install the JDK
2. Download and install the SDK starter package
-Select a starter package from the table at the top of this page and download -it to your development computer. To install the SDK, simply unpack the starter -package to a safe location and then add the location to your PATH.
+Download a starter package from the table above onto your development computer. +If you're using Windows, we recommend that you download the installer (the {@code .exe} file), +which will launch a Wizard to guide you through the installation and check your computer for +required software. Otherwise, download the SDK starter package ({@code .zip} or {@code .tgz}) +appropriate for your system, unpack it to a safe location, then add the location to your PATH +environment variable.
3. Install the ADT Plugin for Eclipse
-If you are developing in Eclipse, set up a remote update site at
- If you are developing in Eclipse, add a new remote update site with the URL
+ 4. Add Android platforms and other components to your SDK Use the Android SDK and AVD Manager, included in the SDK starter package, to
-add one or more Android platforms (for example, Android 1.6 or Android 2.2) and
-other components to your SDK. If you aren't sure what to add, see Launch the Android SDK and AVD Manager by executing {@code SDK Manager.exe} (Windows) or
+{@code android} (Mac/Linux) from the SDK's {@code tools/} directory (if you used the Windows
+installer, this is launched for you when the Wizard is complete). Add some Android platforms
+(such as Android 1.6 and Android 2.3) and other components (such as documentation) to your SDK. If
+you aren't sure what to add, see Which components do I need? To launch the Android SDK and AVD Manager on Windows, execute Done! If you are new to Android, you can use the Hello World tutorial to
-get started quickly. Next
-Steps offers other suggestions of how to begin. To write your first Android application, see the Hello World tutorial. Also see Next
+Steps for other suggestions about how to get started. For a more detailed guide to installing and setting up the SDK, read For a more detailed guide to installing and setting up the SDK, read Installing the SDK.https://dl-ssl.google.com/android/eclipse/. Install the Android
-Development Tools (ADT) Plugin, restart Eclipse, and set the "Android"
-preferences in Eclipse to point to the SDK install location. For detailed
-instructions, see ADT Plugin
+https://dl-ssl.google.com/android/eclipse/. Install the Android
+Development Tools (ADT) Plugin from that site, restart Eclipse, and set the "Android"
+preferences in Eclipse to point to the Android SDK directory (installed in the previous step). For
+detailed instructions to setup Eclipse, see ADT Plugin
for Eclipse.SDK
-Setup.exe, at the root of the SDK directory. On Mac OS X or Linux,
-execute the android tool in the <sdk>/tools/
-folder. For detailed instructions, see Adding SDK Components.
This page describes how to install the Android SDK +
This page describes how to install the Android SDK and set up your development environment for the first time.
-If you encounter any problems during installation, see the +
If you encounter any problems during installation, see the Troubleshooting section at the bottom of this page.
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 Updating SDK
+ 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 Updating SDK
Components If you are using Android 1.5 SDK or earlier, you should install a new SDK as
@@ -54,65 +54,71 @@ SDK environment. Before getting started with the Android SDK, take a moment to confirm that
your development computer meets the System
-Requirements. In particular, you may need to install the JDK before
+Requirements
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:
- +installed on your computer (3.4 or newer is recommended). If you need +to install Eclipse, you can download it from this location: +http://www.eclipse.org/downloads/
- -A Java or RCP version of Eclipse is recommended. For Eclipse 3.5, the -"Eclipse Classic" version is recommended.
+"http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/ + +A Java or RCP version of Eclipse is recommended. For Eclipse 3.5, the +"Eclipse Classic" version is recommended.
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.
+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).You can get the latest version of the SDK starter package from the SDK download page. Make sure to download the package that is appropriate for your development computer.
-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
-android-sdk-<machine-platform>. 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.
Note: 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.
-Optionally, you may want to add the location of the SDK's primary
-tools directory to your system PATH. The primary
-tools/ directory is located at the root of the SDK folder. Adding
-tools to your path lets you run Android Debug Bridge (adb) and the
-other command line 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 android-sdk-<machine-platform>.
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 and when using +the SDK tools from command line.
+ +Optionally, you might want to add the location of the SDK's primary
+tools directory and the additional {@code platform-tools/} directory to your system
+PATH. Both tool directories are located at the root of the SDK folder. Adding
+tools/ and {@code platform-tools/} to your path lets you run Android Debug Bridge (adb)
+and the other command line tools without needing to
-supply the full path to the tools directory.
~/.bash_profile or ~/.bashrc file. Look
for a line that sets the PATH environment variable and add the
- full path to the tools/ directory to it. If you don't
+ full path to the tools/ and {@code platform-tools/} directories to it. If you don't
see a line setting the path, you can add one:export PATH=${PATH}:<your_sdk_dir>/toolsexport PATH=${PATH}:<your_sdk_dir>/tools:<your_sdk_dir>/platform-tools.bash_profile and
- proceed as for Linux. You can create the .bash_profile if
+ proceed as for Linux. You can create the .bash_profile if
you haven't already set one up on your machine. tools/ directory to the path. tools/ and {@code platform-tools/} directories to the path.
If you will be using the Eclipse IDE as your development environment, the
@@ -203,11 +209,11 @@ access to powerful mapping capabilities through the
com.google.android.maps library. You can also add additional
repositories, so that you can download other SDK add-ons, where available.
-
+
Figure 1. The Android SDK and AVD Manager's +1em;">Figure 1. The Android SDK and AVD Manager's Available Packages panel, which shows the SDK components that are available for you to download into your environment.
-For revision notes and other detailed information about individual SDK -components, see the documents listed under "Downloadable SDK Components" in +
For revision notes and other detailed information about individual SDK +components, see the documents listed under "Downloadable SDK Components" in the navigation at left.
@@ -335,7 +341,7 @@ the navigation at left. and add-ons that you need, open the SDK directory and take a look at what's inside. -The table below describes the full SDK directory contents, with components +
The table below describes the full SDK directory contents, with components installed.
docs/ |
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 offline.html in a web browser. |
||||||
platform-tools/ |
+Contains development tools that may be updated with each platform release (from the Android +SDK Platform-tools 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. | +||||||
platforms/ |
Contains a set of Android platform versions that you can develop applications against, each in a separate directory. | @@ -362,7 +377,7 @@ applications against, each in a separate directory.||||||
<platform>/ |
-Platform version directory, for example "android-1.6". All platform version + | Platform version directory, for example "android-1.6". All platform version directories contain a similar set of files and subdirectory structure. | images/ |
-Storage area for default disk images, including the Android system image, -the default userdata image, the default ramdisk image, and more. The images + | 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. | ||
tools/ |
-Any development tools that are specific to the platform version. | +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. | |||||
| @@ -411,18 +427,21 @@ version. | Sample code and apps that are specific to platform version. | tools/ |
-Contains the set of development and profiling tools available to you, such
-as the emulator, the android tool, adb, ddms, and more. |
+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 Android SDK Tools component), +independent of platform releases, whereas the tools in {@code platform-tools/} may be updated based +on the latest platform release. | |||
SDK Readme.txt |
-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 + | 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 | |||||
SDK Setup.exe |
-Windows SDK only. A shortcut that launches the Android SDK and AVD + | SDK Manager.exe |
+Windows SDK only. A shortcut that launches the Android SDK and AVD Manager tool, which you use to add components to your SDK. | ||||