From 3dec7d563a2f3e1eb967ce2054a00b6620e3558c Mon Sep 17 00:00:00 2001 From: The Android Open Source Project Date: Mon, 2 Mar 2009 22:54:33 -0800 Subject: auto import from //depot/cupcake/@137055 --- docs/html/sdk/1.0_r1/index.jd | 81 +++++++++-------- docs/html/sdk/1.0_r1/installing.jd | 171 +++++++++++++++++++++++++++-------- docs/html/sdk/1.0_r1/upgrading.jd | 103 ++++++++++----------- docs/html/sdk/1.0_r2/index.jd | 81 +++++++++-------- docs/html/sdk/1.0_r2/installing.jd | 171 +++++++++++++++++++++++++++-------- docs/html/sdk/1.0_r2/requirements.jd | 44 +++++++++ docs/html/sdk/1.0_r2/upgrading.jd | 103 ++++++++++----------- docs/html/sdk/1.1_r1/index.jd | 12 +-- docs/html/sdk/1.1_r1/installing.jd | 139 +++++++++++++++++++++++----- docs/html/sdk/sdk_toc.cs | 44 ++++++--- 10 files changed, 644 insertions(+), 305 deletions(-) create mode 100644 docs/html/sdk/1.0_r2/requirements.jd (limited to 'docs/html/sdk') diff --git a/docs/html/sdk/1.0_r1/index.jd b/docs/html/sdk/1.0_r1/index.jd index d236844b70c0..b6e0e9f20992 100644 --- a/docs/html/sdk/1.0_r1/index.jd +++ b/docs/html/sdk/1.0_r1/index.jd @@ -22,43 +22,44 @@ sdk.linux_checksum=2660b4029039b7d714e59827e9a9a11d

Included in this SDK

-

This SDK includes some awesome stuff.

- - -

System and Software Requirements

- -

The following systems and development environments are supported by this SDK.

- -

Supported Operating Systems:

- - -

Supported Development Environments:

- - -

Note: If JDK is already installed on your development computer, please take a moment to make sure that it meets the version requirements listed above. In -particular, note that some Linux distributions may include JDK 1.4 or Gnu Compiler for Java, both of which are not supported for Android development.

\ No newline at end of file +

Development tools

+ +

The SDK includes a variety of tools for developing and debugging application code and designing +an application UI. You can read about the tools in the documentation included with the SDK. +You can access the tools in the <sdk>/tools/ directory.

+ +

System Images

+ +

The Android system images listed below are included in this SDK.

+ + + + + + + + + + + + + + +
System ImageAPI LevelNotesDescription
Android 1.01N/AIncludes the {@code com.google.android.maps} external library and a set of standard development +applications.
+ +

Sample Code and Applications

+ +

You can look at a variety of tutorials and samples in the +documentation included with the SDK and access the sample code itself +in the <sdk>/samples/ directory of the SDK package.

+ +

Documentation

+ +

The SDK package provides a full set of local documentation, including installation and upgrade +instructions. To view it, open the <sdk>/documentation.html file in a web browser. +If you are developing in an IDE such as Eclipse, you can also view the reference documentation +directly in the IDE.

+ + + diff --git a/docs/html/sdk/1.0_r1/installing.jd b/docs/html/sdk/1.0_r1/installing.jd index 0f1539602588..8ac524c44363 100644 --- a/docs/html/sdk/1.0_r1/installing.jd +++ b/docs/html/sdk/1.0_r1/installing.jd @@ -1,29 +1,27 @@ page.title=Installing the SDK +sdk.version=1.0_r1 @jd:body +

For the current SDK release, see the links under Current SDK Release in the side navigation.

-

This page describes how to install the Android SDK and set up your development environment. If you haven't -downloaded the SDK yet, follow the link below.

+

This page describes how to install the Android 1.0 SDK, Release 1, and set up your development environment. +If you haven't downloaded the SDK yet, you can so from the Download page.

-
Download the SDK
+

Before you begin, be sure that your development environment meets the SDK +System Requirements. If you encounter any problems during installation, +see the Installation Notes at the bottom of this page.

-

Before you begin, be sure that you're development environment meets the SDK -System and Software Requirements.

- -

Upgrading?

If you have already developed applications using an earlier version of the SDK, please skip this page and read the -Upgrading the SDK document. +Upgrading the SDK document instead.

-
-

Installing the SDK

-

After downloading the SDK, unpack the .zip archive to a suitable location on your machine. By default, the SDK files are unpacked into a directory named android_sdk_<platform>_<release>_<build>. The directory contains the subdirectories tools/, samples/, and others.

+

After downloading the SDK, unpack the .zip archive to a suitable location on your machine. By default, the SDK files are unpacked into a directory named android_sdk_<platform>_<release>_<build>. The directory contains a link to a local copy of the documentation and the subdirectories tools/, samples/, and others.

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 Android plugin or using SDK tools.

@@ -47,10 +45,86 @@ SDK, please skip this page and read the

Adding 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. Note that, if you update your SDK, you should remember to update your PATH settings to point to the new location, if different.

-

Setting up Eclipse

-

If you'll be developing with the Eclipse IDE, follow the following procedure to setup the IDE -to use the Android SDK.

-

Basically, you just need to update your Eclipse preferences to point to the Android SDK directory:

+ +

If you will be using the Eclipse IDE as your environment for developing Android applications, continue reading the next +section in order to install the Android Development Tools plugin and setup Eclipse. If you choose not to use Eclipse, you can +develop Android applications using other tools — read the guide to developing +In other IDEs.

+ + +

Setting up Eclipse

+ +

First, you should install a custom plugin called Android Development Tools (ADT), which adds integrated support for Android projects and tools. The ADT plugin includes a variety of powerful extensions that make creating, running, and debugging Android applications faster and easier. Developing in ADT/Eclipse is highly recommended for Eclipse users and those new to Android.

+ +

To download and install the ADT plugin, follow the steps below for your respective Eclipse version.

+ + + + + + + +
Eclipse 3.3 (Europa)Eclipse 3.4 (Ganymede)
+
    +
  1. Start Eclipse, then select Help > Software Updates > Find + and Install....
    2. + +
  2. In the dialog that appears, select Search for new features to install and click Next.
    3. +
  3. Click New Remote Site.
    4. +
  4. In the resulting dialog box, enter a name for the remote site (e.g. Android Plugin) and enter this as its URL: + 
    https://dl-ssl.google.com/android/eclipse/
    +

    Alternatively, you can use http in the Location URL, if you are having + trouble with https (https is preferred for security reasons).

    + 
    http://dl-ssl.google.com/android/eclipse/
    +

    Click OK.

    5. +
  5. You should now see the new site added to the search list (and checked). + Click Finish.
    6. +
  6. In the subsequent Search Results dialog box, select the checkbox for + Android Plugin > Developer Tools. + This will check both features: "Android Developer Tools", and "Android + Editors". The Android Editors feature is optional, but recommended. If + you choose to install it, you need the WST plugin mentioned earlier in this + page. Click Next.
    7. +
  7. Read the license agreement and then select Accept terms of the license agreement. + Click Next.
    8. +
  8. Click Finish.
    9. + +
  9. The ADT plugin is not signed; you can accept the installation anyway + by clicking Install All.
    10. +
  10. Restart Eclipse.
    11. +
+ +		 + +
    +
  1. Start Eclipse, then select Help > Software Updates.... +
    2. +
  2. In the dialog that appears, click the Available Software tab. +
    3. +
  3. Click Add Site... +
    4. +
  4. Enter this as the Location: + 
    https://dl-ssl.google.com/android/eclipse/
    +

    Alternatively, you can use http in the Location URL, if you are having + trouble with https (https is preferred for security reasons).

    + 
    http://dl-ssl.google.com/android/eclipse/
    +

    Click OK.

    5. +
  5. Back in the Available Software view, you should see the plugin. Select the checkbox next to + Developer Tools and click Install... +
    6. +
  6. On the subsequent Install window, "Android Developer Tools", and "Android Editors" should both be checked. + The Android Editors feature is optional, but recommended. If + you choose to install it, you need the WST plugin mentioned earlier in this + page. Click Next. +
    7. +
  7. Accept the license agreement and click Finish.
    8. +
  8. Restart Eclipse.
    9. +
+ +
+ + +

Now, you just need to modify your Eclipse preferences to point to the Android SDK directory:

  1. Select Window > Preferences... to open the Preferences panel. (Mac OS X: Eclipse > Preferences)
    2. @@ -58,16 +132,55 @@ to use the Android SDK.

  2. For the SDK Location in the main panel, click Browse... and locate the SDK directory.
  3. Click Apply, then OK.
-

Done! We now recommend that you install the ADT Eclipse plugin, which will provide some much-appreciated assistance in developing Android apps with Eclipse...

- -

Installing the Eclipse Plugin (ADT)

+

Done! If you haven't encountered any problems, then you're ready to begin developing Android applications. +We recommend you begin with the Hello World tutorial, +which will teach you some basics about Android applications and how to create projects using Eclipse.

-

If you will be using the Eclipse IDE as your environment for developing Android applications, you can install a custom plugin called Android Development Tools (ADT), which adds integrated support for Android projects and tools. The ADT plugin includes a variety of powerful extensions that make creating, running, and debugging Android applications faster and easier. This plugin is highly recommended for Eclipse users.

-

If you will not be using the Eclipse IDE, you do not need to download or install the ADT plugin.

+

Troubleshooting ADT Installation

+

+If you are having trouble downloading the ADT plugin after following the steps above, here are some suggestions:

-

Follow this guide to install the ADT Plugin

+ +

+If you are still unable to use Eclipse to download the ADT plugin as a remote update site, you can download the ADT files to your local machine using a browser and the install the files in Eclipse from there: +

+
    +
  1. Download the ADT zip file (do not unpack it). +
  2. Follow steps 1 and 2 in the default install instructions (above). +
  3. In Eclipse 3.3, click New Archive Site....
    + In Eclipse 3.4, click Add Site..., then Archive... +
  4. Browse and select the downloaded the zip file. +
  5. Follow the remaining procedures, above, starting from steps 5. +
+

+Note that to update your plugin, you will have to follow these steps again instead of the default update instructions.

+ +

Note that the "Android Editors" feature of ADT requires several optional +Eclipse components (for example, WST). If you encounter an error when +installing ADT, your Eclipse installion might not include those components. +For information about how to quickly add the necessary components to your +Eclipse installation, see the troubleshooting topic +ADT Installation Error: "requires plug-in org.eclipse.wst.sse.ui".

+ +

For Linux users

+

If you encounter this error when installing the ADT Plugin for Eclipse: +

+An error occurred during provisioning.
+Cannot connect to keystore.
+JKS
+

+...then your development machine lacks a suitable Java VM. Installing Sun +Java 6 will resolve this issue and you can then reinstall the ADT +Plugin.

Installation Notes

@@ -106,19 +219,3 @@ at the top of this page. In particular, note that some Linux distributions may include JDK 1.4 or Gnu Compiler for Java, both of which are not supported for Android development. - - - - - - - - - - - - - - - - diff --git a/docs/html/sdk/1.0_r1/upgrading.jd b/docs/html/sdk/1.0_r1/upgrading.jd index 168f1be288a5..480bff384a9f 100644 --- a/docs/html/sdk/1.0_r1/upgrading.jd +++ b/docs/html/sdk/1.0_r1/upgrading.jd @@ -1,37 +1,12 @@ page.title=Upgrading the SDK +sdk.version=1.0_r1 @jd:body -
-
- -

Useful Links

- -
    -
  • Overview of Changes -

    A high-level look at what's changed in Android, with - discussion of how the changes may affect your apps.

    • - -
  • API Diff Report -

    A detailed report that lists all the specific changes in the latest SDK.

    • - -
  • Release Notes -

    Version details, known issues, and resolved issues.

    • - -
  • Android Developers Group -

    A forum where you can discuss migration issues and learn from other Android developers.

    • - -
  • Android Issue Tracker -

    If you think you may have found a bug, use the issue tracker to report it.

    • -
- -
-
- +

For the current SDK release, see the links under Current SDK Release in the side navigation.

This guide will help you migrate your development environment and applications -to the latest version of the SDK. Use this guide if you've been developing applications -on a previous version of the Android SDK. -

+to version 1.0, release 1, of the Android SDK. Use this guide if you've been developing applications +on a different version of the Android SDK.

To ensure that your applications are compliant with the Android 1.0 system available on mobile devices, you need to install the new SDK and port your existing Android @@ -39,9 +14,7 @@ applications to the updated API. The sections below guide you through the proces

Install the new SDK

-

Download the SDK and unpack it into a safe location.

- -

After unpacking the new SDK, you should:

+

After unpacking the SDK, you should:

- - - - - - - - - - - - - - - - diff --git a/docs/html/sdk/1.0_r2/requirements.jd b/docs/html/sdk/1.0_r2/requirements.jd new file mode 100644 index 000000000000..74d90ef0a332 --- /dev/null +++ b/docs/html/sdk/1.0_r2/requirements.jd @@ -0,0 +1,44 @@ +page.title=System Requirements +sdk.version=1.0_r2 + + +@jd:body + +

The sections below describe the system and software requirements for developing Android applications using the Android SDK tools included in Android 1.0 SDK, Release 2.

+ +

System and Software Requirements

+

The following systems and development environments are supported by this SDK.

+ +

Supported Operating Systems:

+ + +

Supported Development Environments:

+ + +

Note: If JDK is already installed on your development computer, please take a moment to make sure that it meets the version requirements listed above. In +particular, note that some Linux distributions may include JDK 1.4 or Gnu Compiler for Java, both of which are not supported for Android development.

\ No newline at end of file diff --git a/docs/html/sdk/1.0_r2/upgrading.jd b/docs/html/sdk/1.0_r2/upgrading.jd index 168f1be288a5..df9b6579273b 100644 --- a/docs/html/sdk/1.0_r2/upgrading.jd +++ b/docs/html/sdk/1.0_r2/upgrading.jd @@ -1,37 +1,12 @@ page.title=Upgrading the SDK +sdk.version=1.0_r2 @jd:body -
-
- -

Useful Links

- -
    -
  • Overview of Changes -

    A high-level look at what's changed in Android, with - discussion of how the changes may affect your apps.

    • - -
  • API Diff Report -

    A detailed report that lists all the specific changes in the latest SDK.

    • - -
  • Release Notes -

    Version details, known issues, and resolved issues.

    • - -
  • Android Developers Group -

    A forum where you can discuss migration issues and learn from other Android developers.

    • - -
  • Android Issue Tracker -

    If you think you may have found a bug, use the issue tracker to report it.

    • -
- -
-
- +

For the current SDK release, see the links under Current SDK Release in the side navigation.

This guide will help you migrate your development environment and applications -to the latest version of the SDK. Use this guide if you've been developing applications -on a previous version of the Android SDK. -

+to version 1.0, release 2, of the Android SDK. Use this guide if you've been developing applications +on a different version of the Android SDK.

To ensure that your applications are compliant with the Android 1.0 system available on mobile devices, you need to install the new SDK and port your existing Android @@ -39,9 +14,7 @@ applications to the updated API. The sections below guide you through the proces

Install the new SDK

-

Download the SDK and unpack it into a safe location.

- -

After unpacking the new SDK, you should:

+

After unpacking the SDK, you should: