From 38dea272bdea54901dbc269b0666c97acf0a9fa8 Mon Sep 17 00:00:00 2001 From: Scott Main Date: Mon, 1 Nov 2010 13:03:25 -0700 Subject: docs: more revisions to the installing docs for GB Change-Id: Id1d6323fc900daf2f499602d5d64d2f2d2d8d398 --- docs/html/sdk/adding-components.jd | 55 +++------ docs/html/sdk/eclipse-adt.jd | 2 +- docs/html/sdk/index.jd | 2 +- docs/html/sdk/installing.jd | 228 +++++++++++++++++++++++-------------- 4 files changed, 160 insertions(+), 127 deletions(-) (limited to 'docs') diff --git a/docs/html/sdk/adding-components.jd b/docs/html/sdk/adding-components.jd index 755f200..05be0d6 100644 --- a/docs/html/sdk/adding-components.jd +++ b/docs/html/sdk/adding-components.jd @@ -22,11 +22,9 @@ 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 -download.

+

Adding and updating components in your Android SDK is fast and easy. To add or +update the individual SDK components that you need, use the Android SDK and AVD +Manager (included in the SDK Tools).

It only takes a couple of clicks to install individual versions of the Android platform, new development tools, new documentation, and SDK add-ons. The @@ -34,32 +32,17 @@ new SDK components are automatically installed into your existing SDK directory, so you don't need to update your development environment to specify a new SDK location.

-

Because each version of the Android platform can be installed as an -individual component of your SDK, you can customize your development environment -to the Android platforms you are targetting. Testing your app on multiple -versions of the platform is very important in order to successfully operate on -as many devices as possible. Be sure to install each version of the Android -platform with which your app is compatible, then test your apps on AVDs that run each -platform.

- -

If you are just getting started and you are not sure what components to install, -see Adding Platforms and Other -Components for information.

- -

If you develop applications using Eclipse, you may also need to update your -ADT plugin when you update your development tools, in order to compile against -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 -Available Packages -panel, which shows the SDK components that are +

If you're setting up your Android SDK for the first time, +see Installing the SDK for information about +what components to install.

+ +

Note: If you develop in Eclipse, you might also need +to update your ADT plugin when you update your development tools. See the revisions listed in the +ADT Plugin for Eclipse document.

+ + +

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.

@@ -68,13 +51,7 @@ available for you to download into your environment.

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:

- +

You can launch the Android SDK and AVD Manager in one of the following ways.

Launching from Eclipse/ADT

@@ -122,7 +99,7 @@ complete.

from the SDK repository.
  • Select the component(s) you'd like to install and click Install Selected. If you aren't sure which packages to select, read Which components do I need?.
    • + href="installing.html#which">Recommended Components.
  • Verify and accept the components you want and click Install Accepted. The components will now be installed into your existing Android SDK directories.
    • diff --git a/docs/html/sdk/eclipse-adt.jd b/docs/html/sdk/eclipse-adt.jd index ef7d865..632fa4b 100644 --- a/docs/html/sdk/eclipse-adt.jd +++ b/docs/html/sdk/eclipse-adt.jd @@ -632,7 +632,7 @@ href="#installing">Installing the ADT Plugin, above.

    Uninstalling the ADT plugin

    -

    If you encounter problems when installing or updating ADT, you +

    If you encounter problems when installing or updating ADT, you can try removing the existing ADT plugin and then performing a fresh installation. To remove ADT, follow these steps:

    diff --git a/docs/html/sdk/index.jd b/docs/html/sdk/index.jd index 2e59801..2812ae8 100644 --- a/docs/html/sdk/index.jd +++ b/docs/html/sdk/index.jd @@ -57,7 +57,7 @@ for Eclipse.

    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?

    +href="installing.html#which">Recommended Components

    Done!

    diff --git a/docs/html/sdk/installing.jd b/docs/html/sdk/installing.jd index c3b103f..5b5c4f4 100644 --- a/docs/html/sdk/installing.jd +++ b/docs/html/sdk/installing.jd @@ -3,6 +3,49 @@ sdk.preview=0 @jd:body + + + +
    @@ -12,10 +55,10 @@ sdk.preview=0
  • 2. Downloading the SDK Starter Package
  • 3. Installing the ADT Plugin for Eclipse
  • 4. Adding Platforms and Other Components -
      -
    1. Which components do I need?
      2. -
    • -
  • Exploring the SDK
    • +
      +
    1. Recommended Components
      2. +
    +
  • 5. Exploring the SDK
  • Next Steps
  • Troubleshooting
    • @@ -65,16 +108,9 @@ RCP version of Eclipse is recommended.

    Step 2. Downloading the SDK Starter Package

    -

    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 +

    The SDK 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 (such as the platform system images).

    - -

    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.

    +use to download the rest of the SDK components (such as the latest Android platform).

    You can get the latest version of the SDK starter package from the SDK download page.

    @@ -90,7 +126,17 @@ the SDK tools from command line.

    Optionally, you might want to add the location of the SDK's tools/ directory and {@code platform-tools/} directory to your system -PATH. Both tool directories are located at the root of the SDK folder. Adding +PATH. Both tool directories are located at the root of the SDK folder. + + +

    + + + How to update your PATH +
    + +

    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 @@ -100,9 +146,10 @@ supply the full path to the tool directories.

  • On Linux, edit your ~/.bash_profile or ~/.bashrc file. Look for a line that sets the PATH environment variable and add the 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:
    • + see a line setting the path, you can add one: -
      export PATH=${PATH}:<your_sdk_dir>/tools:<your_sdk_dir>/platform-tools
    + 
    export PATH=${PATH}:<your_sdk_dir>/tools:<your_sdk_dir>/platform-tools
    +
  • On a Mac OS X, look in your home directory for .bash_profile and proceed as for Linux. You can create the .bash_profile if @@ -114,12 +161,9 @@ supply the full path to the tool directories.

    tools/ and {@code platform-tools/} directories to the path.
    • -

    If you will be using the Eclipse IDE, the -next section describes how to install the Android Development Tools (ADT) plugin -and set up Eclipse. If you choose not to use Eclipse, you can develop Android -applications in an IDE of your choice and then compile, debug and deploy using -the tools included in the SDK (skip to Adding Platforms -and Other Components).

    +
    +
    +

    Step 3. Installing the ADT Plugin for Eclipse

    @@ -139,26 +183,14 @@ Read Installing the ADT Plug step-by-step installation instructions, then return here to continue the last step in setting up your Android SDK.

    -

    If you prefer to work in an IDE other than Eclipse, you do not need to +

    If you prefer to work in a different IDE, you do not need to install Eclipse or ADT, instead, you can directly use the SDK tools to build and -debug your application.

    - - -

    Step 4. Adding Android Platforms and Other Components

    +debug your application. The developer guide has more information about     Developing in Other IDEs.

    -
    -

    Using the Android SDK and AVD Manager

    -

    The Android SDK and AVD Manager is a tool that you will use often -to add components to your SDK environment and manage Android Virtual Devices. -

    -

    See Adding SDK Components for details on how to -launch and use the tool.

    -
    -
    +

    Step 4. Adding Android Platforms and Other Components

    The last step in setting up your SDK is using the Android SDK and AVD Manager (a tool included in the SDK starter package) to download @@ -167,20 +199,48 @@ essential SDK components into your development environment.

    The SDK uses a modular structure that separates the major parts of the SDK—Android platform versions, add-ons, tools, samples, and documentation—into a set of separately installable components. The SDK starter package, which you've already downloaded, includes only a single -component: the latest version of the SDK Tools. To develop any Android -application, you also need to download at least one Android platform into your -environment, although downloading additional components is highly recommended. -See Which components do I need? for information about -which components are required and which are optional.

    +component: the latest version of the SDK Tools. To develop an Android +application, you also need to download at least one Android platform and the SDK Platform-tools +(tools that the latest platform depend upon). However, downloading +additional components is highly recommended.

    + +

    You can launch the Android SDK and AVD Manager in one of the following ways:

    +
      +
    • From within Eclipse, select Window > Android SDK and AVD Manager.
      • +
    • On Windows, double-click the SDK Manager.ext file at the root of the Android +SDK directory.
      • +
    • On Mac or Linux, open a terminal and navigate to the tools/ directory in the +Android SDK, then execute: 
      android update sdk

      This will automatically select +the required and recommended components for you to install.

      • +
    + +

    To download components, use the graphical UI of the Android SDK and AVD +Manager, shown in Figure 1, to browse the SDK repository and select new or updated +components. The Android SDK and AVD Manager will install the selected components in +your SDK environment. For information about which components you should download, see the following +section about Recommended Components

    + + +

    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 SDK repository offers these types of components:

    • SDK Tools (pre-installed in the Android SDK starter -package) — Contains the full set of SDK tools for developing, debugging, -and testing your application code and UI. You can read about the tools in the Dev Guide and access them -in the <sdk>/tools/ directory.
      • +package) — Contains tools for debugging +and testing your application and other utility tools. You can access these +in the <sdk>/tools/ directory of your SDK and read more about them in the Tools section of the developer guide. + +
    • SDK Platform-tools — Contains tools that are required to develop and +debug your application, but which are developed alongside the Android platform in order to support +the latest features. These tools are typically updated only when a new platform becomes +available. You can access these +in the <sdk>/platform-tools/ directory. Read more about them in +the Tools section of the developer guide. +
    • Android platforms — An SDK platform is available for every production Android platform deployable to Android-powered @@ -215,28 +275,13 @@ tutorials. -->
      • multiversion documentation for the Android framework API.
    -

    To download components, use the graphical UI of the Android SDK and AVD -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.

    - -
    - -

    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.

    -
    - -

    Which components do I need?

    +

    Recommended Components

    The SDK repository contains a range of components that you can download. Use the table below to determine which components you need, based on whether you -want to set up a basic (but functionnal) development environment or a -recommended or full development environment:

    +want to set up a basic, recommended, or full development environment: +

    @@ -247,12 +292,21 @@ recommended or full development environment:

    - - - + + + + + + + + @@ -263,14 +317,15 @@ you will be able to compile your application and set up an Android Virtual Device (AVD) to run it on (in the emulator). To start with, just download the latest version of the platform. Later, if you plan to publish your application, you will want to download other platforms as well, so that you can test your -application on the full range of Android platform versions that your customers -are using. +application on the full range of Android platform versions that your application supports. - + - + @@ -292,10 +347,12 @@ debugging and testing. For Mac OS X and Linux platforms, no special driver is needed. - + - +
    BasicSDK ToolsIf you've installed -the SDK starter package, then you already have this component preinstalled. The -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.BasicSDK ToolsIf you've just installed +the SDK starter package, then you already have the latest version of this component. The +SDK Tools component is required to develop an Android application. Make sure you keep this up to +date.
    SDK Platform-toolsThis includes more tools that are required +for application development. These tools are platform-dependent and typically update only when +a new SDK platform is made available, in order to support new features in the platform. 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.
    ++
    RecommendedRecommended
    (plus Basic)    		 Documentation The Documentation component is useful because it lets you work offline and also look up API reference information from inside Eclipse.
    ++
    FullFull
    (plus Recommended)    		 Google APIs The Google APIs add-on gives your application access to the Maps external library, which makes it easy to display and manipulate Maps data in your @@ -314,13 +371,12 @@ applications on different platforms by running in an Android Virtual Device
    -

    For step-by-step instructions on how to use the Android SDK and AVD Manager -to add components, see the Adding -SDK Components document.

    +

    Once you've installed at least the basic configuration of SDK components, you're ready to start +developing Android apps. The next section describes the contents of the Android SDK to familiarize +you with the components you've just installed.

    -

    For revision notes and other detailed information about individual SDK -components, see the documents listed under "Downloadable SDK Components" in -the navigation at left.

    +

    For more information about using the Android SDK and AVD Manager, see the Adding SDK Components document.

    Step 5. Exploring the SDK

    @@ -341,7 +397,7 @@ installed.

    Contains add-ons to the Android SDK development environment, which let you develop against external libraries that are available on some devices. -repo + docs/ A full set of documentation in HTML format, including the Developer's Guide, @@ -454,7 +510,7 @@ begin developing applications. Here are a few ways you can get started:

    -

    Following the Hello World tutorial is an essential +

    Following the Hello World tutorial is an essential first step in getting started with Android development.

    Learn about Android

    @@ -494,7 +550,7 @@ Android-powered device to run and test your application. and architectural concepts in a moderately complex application. -

    Following the Notepad tutorial is an excellent +

    Following the Notepad tutorial is an excellent second step in getting started with Android development.

    Explore some code

    -- cgit v1.1