diff --git a/docs/html/sdk/exploring.jd b/docs/html/sdk/exploring.jd index 77490602d5c61..b34c1cf9acbd3 100644 --- a/docs/html/sdk/exploring.jd +++ b/docs/html/sdk/exploring.jd @@ -5,163 +5,6 @@ walkthru=1 @jd:body -

The Android SDK is composed of modular packages that you can download separately using -the Android SDK Manager. For example, when the SDK Tools are updated or a new version of -the Android platform is released, you can use the SDK Manager to quickly download them to -your environment. Simply follow the procedures described in Adding Platforms and Packages.

- -

There are several different packages available for the Android SDK. The table below describes -most of the available packages and where they're located once you download them.

- - -

Available Packages

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PackageDescriptionFile Location
SDK ToolsContains tools for debugging and testing, plus other -utilities that are required to develop an app. If you've just installed the SDK starter package, -then you already have the latest version of this package. Make sure you keep this up to date.{@code <sdk>/tools/}
SDK Platform-toolsContains platform-dependent tools for developing and debugging -your application. These tools support the latest features of the Android platform and are typically -updated only when a new platform becomes available. These tools are always backward compatible with -older platforms, but you must be sure that you have the latest version of these tools when you -install a new SDK platform.{@code <sdk>/platform-tools/}
DocumentationAn offline copy of the latest documentation for the Android -platform APIs.{@code <sdk>/docs/}
SDK PlatformThere's one SDK Platform available for each version of Android. It includes an {@code -android.jar} file with a fully compliant Android library. In order to build an Android app, you must -specify an SDK platform as your build target.{@code <sdk>/platforms/<android-version>/}
System ImagesEach platform version offers one or more different system images (such as for ARM -and x86). The Android emulator requires a system image to operate. You should always test your -app on the latest version of Android and using the emulator with the latest system image is a -good way to do so.{@code <sdk>/platforms/<android-version>/}
Sources for Android SDKA copy of the Android platform source code that's useful for -stepping through the code while debugging your app.{@code <sdk>/sources/}
Samples for SDKA collection of sample apps that demonstrate a variety of the -platform APIs. These are a great resource to browse Android app code. The API Demos app in -particular provides a huge number of small demos you should explore.{@code <sdk>/platforms/<android-version>/samples/}
Google APIsAn SDK add-on that provides both a platform you can use to develop an app -using special Google APIs and a system image for the emulator so you can test your app using the -Google APIs.{@code <sdk>/add-ons/}
Android SupportA static library you can include in your app sources in order to use powerful -APIs that aren't available in the standard platform. For example, the support library -contains versions of the {@link android.support.v4.app.Fragment} class that's compatible with -Android 1.6 and higher (the class was originally introduced in Android 3.0) and the {@link -android.support.v4.view.ViewPager} APIs that allow you to easily build a side-swipeable UI.{@code <sdk>/extras/android/support/}
Google Play BillingProvides the static libraries and samples that allow you to -integrate billing services in your app with Google Play.{@code <sdk>/extras/google/}
Google Play LicensingProvides the static libraries and samples that allow you to perform license verification for -your app when distributing with Google Play.{@code <sdk>/extras/google/}
- -

The above table is not comprehensive and you can add new sites to download additional packages from third-parties.

- -

In some cases, an SDK package may require a specific minimum revision of -another package or SDK tool. For example, there may be a dependency between the ADT Plugin for -Eclipse and -the SDK Tools package. When you install the SDK Tools -package, you should also upgrade to the required version of ADT (if you -are developing in Eclipse). In this case, the major version number for your ADT plugin should -always match the revision number of your SDK Tools (for example, ADT 8.x requires SDK Tools r8). -

- -

The development tools will notify you with debug warnings if there is dependency that you need to -address. The Android SDK Manager also enforces dependencies by requiring that you download any -packages that are needed by those you have selected.

- - - - - -

Adding New Sites

- -

By default, Available Packages displays packages available from the -Android Repository and Third party Add-ons. You can add other sites that host -their own Android SDK add-ons, then download the SDK add-ons -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 -to develop using their libraries, you must install their Android SDK add-on, if it's not already -available under Third party Add-ons.

- -

If a carrier or device manufacturer has hosted an SDK add-on repository file -on their web site, follow these steps to add their site to the Android SDK -Manager:

- -
    -
  1. Select Available Packages in the left panel.
    2. -
  2. Click Add Add-on Site and enter the URL of the -repository.xml file. Click OK.
    3. -
-

Any SDK packages available from the site will now be listed under a new item named -User Add-ons.

- - - - -

Troubleshooting

- -

Problems connecting to the SDK repository

- -

If you are using the Android SDK Manager to download packages and are encountering -connection problems, try connecting over http, rather than https. To switch the -protocol used by the Android SDK Manager, follow these steps:

- -
    -
  1. With the Android SDK Manager window open, select "Settings" in the - left pane.
    2. -
  2. On the right, in the "Misc" section, check the checkbox labeled "Force - https://... sources to be fetched using http://..."
    3. -
  3. Click Save & Apply.
    4. -
- diff --git a/docs/html/sdk/index.jd b/docs/html/sdk/index.jd index 9ee1ccae6353a..26e8f30e128ba 100644 --- a/docs/html/sdk/index.jd +++ b/docs/html/sdk/index.jd @@ -206,12 +206,10 @@ This is the Android Software Development Kit License Agreement diff --git a/docs/html/sdk/installing/adding-packages.jd b/docs/html/sdk/installing/adding-packages.jd index bba936e84d4d8..c38c9277b8c65 100644 --- a/docs/html/sdk/installing/adding-packages.jd +++ b/docs/html/sdk/installing/adding-packages.jd @@ -1,63 +1,222 @@ -page.title=Adding Platforms and Packages +page.title=Adding SDK Packages @jd:body + -

The Android SDK separates tools, platforms, and other components into packages you can - download using the Android SDK Manager. The original -SDK package you've downloaded includes only the SDK Tools. To develop an Android app, -you also need to download at least one Android platform and the latest SDK Platform-tools.

-
    -
  1. Launch the SDK Manager. -

    If you've used the Windows installer to install the SDK tools, you should already have the -Android SDK Manager open. Otherwise, you can launch the Android SDK Manager in one of the following -ways:

    +

    +By default, the Android SDK does not include everything you need to start developing. +The SDK separates tools, platforms, and other components into packages you can +download as needed using the +Android SDK Manager. +So before you can start, there are a few packages you should add to your Android SDK.

    + +

    To start adding packages, launch the Android SDK Manager in one of the following ways:

    + +
      +
    1. +

      Get the latest SDK tools

      + + + +

      As a minimum when setting up the Android SDK, + you should download the latest tools and Android platform:

      +
        +
      1. Open the Tools directory and select: +
          +
        • Android SDK Tools
          • +
        • Android SDK Platform-tools
          • +
        • Android SDK Build-tools
          • +
        +
        2. +
      2. Open the first Android X.X folder (the latest version) and select: +
          +
        • SDK Platform
          • +
        • A system image for the emulator, such as
          + ARM EABI v7a System Image
          • +
        +
        3. +
      3. Click Install.
        4. +
      2. -
    2. The SDK Manager shows all the SDK packages available for you to add to your Android SDK. -As a minimum configuration for your SDK, we recommend you install the following: -
        -
      • The latest Tools packages (check the Tools folder).
        • -
      • The latest version of Android (check the first Android folder).
        • -
      • The Android Support Library (open the Extras folder and check - Android Support Library).
        • -
      +
    3. +

      Get the support library for additional APIs

      + +
      +

      Why use the support library?

      + +

      The support library is required for:

      + + +

      The support library also provides these popular APIs:

      + +
      + +

      The Android Support Library + provides an extended set of APIs that are compatible with most versions of Android.

      + +

      To download the support library:

      +
        +
      1. Open the Extras directory and select: +
          +
        • Android Support Repository
          • +
        • Android Support Library
          • +
        +
        2. +
      2. Click Install.
        3. +
      + +

       

      +

       

      + +
      4. + + +
    4. +

      Get Google Play services for even more APIs

      + +
      +

      Why use Google Play services?

      + +

      The Google Play services APIs provide a variety of features and services for your Android + apps, such as:

      + +
      + +

      To develop with Google APIs, you need the Google Play services package:

      +
        +
      1. Open the Extras directory and select: +
          +
        • Google Repository
          • +
        • Google Play services
          • +
        +
        2. +
      2. Click Install.
        3. +
      + +

      Note: Google Play services APIs are not available on all + Android-powered devices, but are available on all devices with Google Play Store. To use these + APIs in the Android emulator, you must also install the the Google APIs + system image from the latest Android X.X directory in the SDK Manager.

      +
      5. + + + +
    5. +

      Build something!

      + +

      With the above packages now in your Android SDK, you're ready to build apps +for Android. As new tools and other APIs become available, simply launch the SDK Manager + to download the new packages for your SDK.

      + +

      Here are a few options for how you should proceed:

      + +
      +
      +

      Get started

      +

      If you're new to Android development, learn the basics of Android apps by following +the guide to Building Your First App.

      + +
      +
      +

      Build for wearables

      +

      If you're ready to start building apps for Android wearables, see the guide to +Building Apps for Android Wear.

      + +
      +
      +

      Use Google APIs

      +

      To start using Google APIs, such as Maps or +Play Game services, see the guide to +Accessing Google Play Services +APIs.

      + +
      +
      + + +
      6. -

      Once you've chosen your packages, click Install. The Android SDK Manager -installs the selected packages into your Android SDK environment.

    -

    With these packages installed, you're ready to start developing. -To get started, read Building Your First App.

    - - -

    Figure 1. The Android SDK Manager shows the -SDK packages that are available, already installed, or for which an update is available.

    - - - -

    Additional information

    - - - diff --git a/docs/html/sdk/installing/bundle.jd b/docs/html/sdk/installing/bundle.jd index 1f7da559be885..22bdd117ae24a 100644 --- a/docs/html/sdk/installing/bundle.jd +++ b/docs/html/sdk/installing/bundle.jd @@ -1,45 +1,3 @@ page.title=Setting Up the ADT Bundle @jd:body - - -

    The ADT Bundle provides everything you need to start developing apps, including -a version of the Eclipse IDE with built-in ADT (Android Developer Tools) to -streamline your Android app development. -If you haven't already, go download the Android ADT Bundle. (If you downloaded the SDK Tools only, for use with an -existing IDE, you should instead read -Setting Up an Existing IDE.)

    - -

    Install the SDK and Eclipse IDE

    -
      -
    1. Unpack the ZIP file -(named {@code adt-bundle-<os_platform>.zip}) and save it to an appropriate location, -such as a "Development" directory in your home directory.
      2. -
    2. Open the {@code adt-bundle-<os_platform>/eclipse/} directory and launch -eclipse.
      3. -
    - -

    That's it! The IDE is already loaded with the Android Developer Tools plugin and -the SDK is ready to go. To start developing, read Building Your First App.

    - -

    Caution: Do not move any of the files or directories -from the {@code adt-bundle-<os_platform>} directory. If you move the {@code eclipse} -or {@code sdk} directory, ADT will not be able to locate the SDK and you'll -need to manually update the ADT preferences.

    - -

    Additional information

    - -

    As you continue developing apps, you may need to install additional versions -of Android for the emulator and other packages such as the library for -Google Play In-app Billing. To install more packages, use -the SDK Manager.

    - -

    Everything you need to develop Android apps is on this web site, including design guidelines, -developer training, API reference, and information -about how you can distribute your app. -For additional resources about developing and distributing your app, see the -Developer Support Resources.

    \ No newline at end of file diff --git a/docs/html/sdk/installing/index.jd b/docs/html/sdk/installing/index.jd index 6b63ba72be0fb..b6929bd31215e 100644 --- a/docs/html/sdk/installing/index.jd +++ b/docs/html/sdk/installing/index.jd @@ -1,19 +1,213 @@ -page.title=Setting Up an Existing IDE +page.title=Installing the Android SDK @jd:body - -

    You should have already downloaded the Android SDK Tools. (If you downloaded the ADT Bundle, you should instead read -Setting Up the ADT Bundle.)

    - -

    The SDK Tools package is not the complete SDK environment. It includes only the core SDK tools, which you can -use to download the rest of the SDK packages (such as the latest system image).

    + -