am b590b0b3: am 6453dfb7: update Download and installation guides for ADT Bundle (ef651ee6) · Commits · e / os / android_frameworks_base

docs/html/sdk/index.jd

+291 −61

File changed.

Preview size limit exceeded, changes collapsed.

docs/html/sdk/installing/adding-packages.jd

+20 −49

Original line number	Diff line number	Diff line
		page.title=Adding Platforms and Packages
		walkthru=1

		@jd:body

		@@ -9,8 +8,8 @@ walkthru=1
		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.</p>

		<p>You can update and install SDK packages at any time using the Android SDK Manager.</p>

		<ol>
		<li>Launch the SDK Manager.
		<p>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:</p>
		@@ -20,14 +19,18 @@ SDK directory.</li>
		<li>On Mac or Linux, open a terminal and navigate to the <code>tools/</code> directory in the
		Android SDK, then execute <code>android sdk</code>.</li>
		</ul>
		</li>

		<p>When you open the Android SDK Manager, it automatically selects a set of recommended packages.
		<li>When the Android SDK Manager opens, it automatically selects a set of recommended packages,
		as shown in figure 1.
		Simply click <strong>Install</strong> to install the recommended packages. The Android SDK Manager
		installs the selected packages into
		your Android SDK environment. The following sections describe some of the available SDK
		packages and more about which ones we recommend you install.</p>
		your Android SDK environment.</li>
		</ol>

		<p>Once you have installed your packages, continue to the next page.</p>
		<p>If you install the recommended packages, you're now ready to start developing apps!
		To start developing, read <a href="{@docRoot}training/basics/firstapp/index.html"
		>Building Your First App</a>.</p>

		<img src="/images/sdk_manager_packages.png" alt="" />
		<p class="img-caption"><strong>Figure 1.</strong> The Android SDK Manager shows the
		@@ -35,49 +38,17 @@ SDK packages that are available, already installed, or for which an update is av



		<h3>Additional information</h3>

		<h2 id="Recommended">Recommended Packages</h2>

		<p>Here's an outlines of the packages required and those we recommend you use:
		</p>
		<p>For more information about using the SDK Manager and some of the available packages,
		see the <a href="{@docRoot}tools/help/sdk-manager.html">SDK Manager</a> document.</p>

		<dl>
		<dt>SDK Tools</dt>
		<dd><strong>Required.</strong> Your new SDK installation already has the latest version. Make sure
		you keep this up to date.</dd>
		<dt>SDK Platform-tools</dt>
		<dd><strong>Required.</strong> You must install this package when you install the SDK for
		the first time.</dd>
		<dt>SDK Platform</dt>
		<dd><strong>Required.</strong>You must download <em>at least one platform</em> into your
		environment so you're able to compile your application. In order to provide the best user experience
		on the latest devices, we recommend that you use the latest platform version as your build target.
		You'll still be able to run your app on older versions, but you must build against the latest
		version in order to use new features when running on devices with the latest version of Android.
		<p>To get started, download the latest Android version, plus the lowest version you plan
		to support (we recommend Android 2.2 for your lowest version).</p></dd>
		<dt>System Image</dt>
		<dd>Recommended. Although you might have one or more Android-powered devices on which to test
		your app, it's unlikely you have a device for every version of Android your app supports. It's
		a good practice to download system images for all versions of Android your app supports and test
		your app running on them with the <a href="{@docRoot}tools/devices/emulator.html">Android emulator</a>.</dd>
		<dt>Android Support</dt>
		<dd>Recommended. Includes a static library that allows you to use some of the latest
		Android APIs (such as <a href="{@docRoot}guide/components/fragments.html">fragments</a>,
		plus others not included in the framework at all) on devices running
		a platform version as old as Android 1.6. All of the activity templates available when creating
		a new project with the <a href="{@docRoot}tools/sdk/eclipse-adt.html">ADT Plugin</a>
		require this. For more information, read <a
		href="{@docRoot}tools/extras/support-library.html">Support Library</a>.</dd>
		<dt>SDK Samples</dt>
		<dd>Recommended. The samples give you source code that you can use to learn about
		Android, load as a project and run, or reuse in your own app. Note that multiple
		samples packages are available — one for each Android platform version. When
		you are choosing a samples package to download, select the one whose API Level
		matches the API Level of the Android platform that you plan to use.</dd>
		</dl>
		<p>Everything you need to develop Android apps is on this web site, including <a
		href="{@docRoot}design/index.html">design guidelines</a>,
		<a href="{@docRoot}training/index.html">developer training</a>, <a
		href="{@docRoot}reference/packages.html">API reference</a>, and information
		about how you can <a href="{@docRoot}distribute/index.html">distribute your app</a>.
		For additional resources about developing and distributing your app, see the
		<a href="{@docRoot}support.html">Developer Support Resources</a>.</p>


		<p class="note"><strong>Tip:</strong> For easy access to the SDK tools from a command line, add the
		location of the SDK's <code>tools/</code> and
		<code>platform-tools</code> to your <code>PATH</code> environment variable.</p>

docs/html/sdk/installing/bundle.jd

0 → 100644

+44 −0

Original line number	Diff line number	Diff line
		page.title=Setting Up the ADT Bundle

		@jd:body


		<p>The ADT Bundle provides everything you need to start developing apps, including
		a powerful IDE based on Eclipse called ADT (Android Developer Tools).
		If you haven't already, go download the <a href="{@docRoot}sdk/index.html"
		>Android ADT Bundle</a>. (If you downloaded the SDK Tools only, for use with an
		existing IDE, you should instead read
		<a href="{@docRoot}sdk/installing/index.html">Setting Up an Existing IDE</a>.)</p>

		<h3>Install the SDK and Eclipse IDE</h3>
		<ol>
		<li>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.</li>
		<li>Open the {@code adt-bundle-<os_platform>/eclipse/} directory and launch
		<strong>eclipse</strong>.</li>
		</ol>

		<p>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 <a href="{@docRoot}training/basics/firstapp/index.html"
		>Building Your First App</a>.</p>

		<p class="caution"><strong>Caution:</strong> 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.</p>

		<h3>Additional information</h3>

		<p>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 <a href="{@docRoot}tools/help/sdk-manager.html">SDK Manager</a>.</p>

		<p>Everything you need to develop Android apps is on this web site, including <a
		href="{@docRoot}design/index.html">design guidelines</a>,
		<a href="{@docRoot}training/index.html">developer training</a>, <a
		href="{@docRoot}reference/packages.html">API reference</a>, and information
		about how you can <a href="{@docRoot}distribute/index.html">distribute your app</a>.
		For additional resources about developing and distributing your app, see the
		<a href="{@docRoot}support.html">Developer Support Resources</a>.</p>
		No newline at end of file

docs/html/sdk/installing/index.jd

+46 −26

Original line number	Diff line number	Diff line
		page.title=Installing the SDK
		walkthru=1
		page.title=Setting Up an Existing IDE

		@jd:body


		<p>You should have already downloaded the <a href="{@docRoot}sdk/index.html">Android SDK</a>. Now
		you need to set up your development environment.</p>
		<p>You should have already downloaded the <a href="{@docRoot}sdk/index.html#ExistingIDE"
		>Android SDK Tools</a>. (If you downloaded the ADT Bundle, you should instead read
		<a href="{@docRoot}sdk/installing/bundle.html">Setting Up the ADT Bundle</a>.)</p>

		<p>The SDK you've downloaded is not the complete SDK environment. It includes only the core SDK tools, which you can
		<p>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).</p>


		@@ -18,13 +18,20 @@ use to download the rest of the SDK packages (such as the latest system image).<
		for required tools, such as the proper Java SE Development Kit (JDK) and installs it if necessary.
		The installer then saves the Android SDK Tools into a default location (or you can specify the location).</p>

		<p>Make a note of the name and location of the SDK directory on your system—you will need to
		<ol>
		<li>Double-click the executable ({@code .exe} file) to start the install.</li>
		<li>Make a note of the name and location in which it saves the SDK 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 the command line.</p>

		<p>Once the tools are installed, the installer offers to start the Android SDK Manager. Start it and
		continue with the installation guide by clicking the
		<strong>Next</strong> link on the right.</p>
		the SDK tools from the command line.</li>
		<li>Once the installation completes. the installer offers to start the Android SDK Manager.
		If you'll be using Eclipse, <strong>do not</strong> start the Android SDK Manager,
		and instead move on to <a href="{@docRoot}sdk/installing/installing-adt.html"
		>Installing the Eclipse Plugin</a>.
		<p>If you're using a different IDE,
		start the SDK Manager and read <a href="{@docRoot}sdk/installing/adding-packages.html"
		>Adding Platforms and Packages</a>.</p>
		</li>
		</ol>

		</div>

		@@ -34,16 +41,20 @@ continue with the installation guide by clicking the

		<h3>Getting started on Mac</h3>

		<p>Your download package is {@code .zip}.
		Unpack it to a safe location on your machine. By default, the SDK files are unpacked
		into a directory named <code>android-sdk-mac_x86</code>.</p>
		<ol>
		<li>Unpack the ZIP file you've downloaded. By default, it's unpacked
		into a directory named <code>android-sdk-mac_x86</code>. Move it to an appropriate location on your machine,
		such as a "Development" directory in your home directory.

		<p>Make a note of the name and location of the 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 the command line.</p>

		<p>Now continue with the installation guide by clicking the
		<strong>Next</strong> link on the right.</p>
		</li>
		<li>If you're using Eclipse, move on to <a href="{@docRoot}sdk/installing/installing-adt.html"
		>Installing the Eclipse Plugin</a>. Otherwise, if you're using a different IDE,
		read <a href="{@docRoot}sdk/installing/adding-packages.html"
		>Adding Platforms and Packages</a>.</li>
		</ol>

		</div>

		@@ -54,20 +65,27 @@ the SDK tools from the command line.</p>

		<h3>Getting started on Linux</h3>

		<p>Your download package is a {@code .tgz}.
		Unpack it to a safe location on your machine. By default, the SDK files are unpacked
		into a directory named <code>android-sdk-linux_x86</code>.</p>
		<ol>
		<li>Unpack the {@code .tgz} file you've downloaded. By default, the SDK files are unpacked
		into a directory named <code>android-sdk-linux_x86</code>. Move it to an appropriate location on your machine,
		such as a "Development" directory in your home directory.

		<p>Make a note of the name and location of the 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 the command line.</p>

		<p>Now continue with the installation guide by clicking the
		<strong>Next</strong> link on the right.</p>
		</li>
		<li>If you're using Eclipse, move on to <a href="{@docRoot}sdk/installing/installing-adt.html"
		>Installing the Eclipse Plugin</a>. Otherwise, if you're using a different IDE,
		read <a href="{@docRoot}sdk/installing/adding-packages.html"
		>Adding Platforms and Packages</a>.</li>
		</ol>


		<h4 id="Troubleshooting">Troubleshooting Ubuntu</h4>
		<h5 id="Troubleshooting"><a href='' class="expandable"
		onclick="toggleExpandable(this,'#ubuntu-trouble');return false;"
		>Troubleshooting Ubuntu</a></h5>

		<div id="ubuntu-trouble" style="display:none">
		<ul>
		<li>If you need help installing and configuring Java on your
		development machine, you might find these resources helpful:
		@@ -95,10 +113,12 @@ the SDK tools from the command line.</p>
		</ol>
		</li>
		</ul>
		</div><!-- end ubuntu trouble -->


		</div>

		<p><a href='' onclick='showAll();return false;'>Other platforms</a></p>
		<p style="margin-top:2em;"><a href='' onclick='showAll();return false;'>Information for other platforms</a></p>

		<script>
		var $osDocs;

docs/html/sdk/installing/installing-adt.jd

+12 −59

Original line number	Diff line number	Diff line
		page.title=Installing the Eclipse Plugin
		walkthru=1
		adt.zip.version=20.0.3
		adt.zip.download=ADT-20.0.3.zip
		adt.zip.bytes=12390954
		adt.zip.checksum=869a536b1c56d0cd920ed9ae259ae619
		adt.zip.version=21.0.0
		adt.zip.download=ADT-21.0.0.zip
		adt.zip.bytes=13556487
		adt.zip.checksum=7db4eaae5df6a34fd853317a2bd8250b

		@jd:body

		@@ -16,21 +15,13 @@ of Eclipse to let you quickly set up new Android projects, build an app
		UI, debug your app, and export signed (or unsigned) app packages (APKs) for distribution.
		</p>

		<p>If you will be developing in Eclipse with the ADT Plugin, first make sure that you have a
		suitable version of Eclipse
		installed on your computer as described by the
		<a href="{@docRoot}sdk/index.html#Requirements">system requirements</a>.</p>

		<p>If you need to install Eclipse, you can download it from <a href=
		"http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a>.
		We recommend the "Eclipse Classic" version. Otherwise, you should use a Java or
		RCP version of Eclipse.</p>
		"http://eclipse.org/mobile/">eclipse.org/mobile</a>.</p>


		<p class="note"><strong>Note:</strong> 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. So if you're not using Eclipse, continue to the next page by clicking
		the <strong>Next</strong> link on the right.</p>
		debug your application.</p>



		@@ -70,59 +61,21 @@ the software can't be established, click <strong>OK</strong>.</p></li>
		<li>In the "Welcome to Android Development" window that appears, select <strong>Use
		existing SDKs</strong>.</li>
		<li>Browse and select the location of the Android SDK directory you recently
		downloaded.</li>
		downloaded and unpacked.</li>
		<li>Click <strong>Next</strong>.</li>
		</ol>

		<p>Your Eclipse IDE is now set up to develop Android apps, but you need to add
		the latest SDK platform tools and an Android platform to your environment.
		To get these packages for your SDK, continue to
		<a href="{@docRoot}sdk/installing/adding-packages.html">Adding Platforms and Packages</a>.</p>

		<p>If you haven't encountered any errors, you're done setting up ADT
		and can continue to <a href="{@docRoot}sdk/installing/next.html">Next Steps</a>.</p>




		<h2 id="Updating">Updating the ADT Plugin</h2>

		<p>From time to time, a new revision of the ADT Plugin becomes available, with
		new features and bug fixes. Generally, when a new revision of ADT is available,
		you should update to it as soon as convenient. </p>

		<p>In some cases, a new revision of ADT will have a dependency on a specific
		revision of the Android SDK Tools. If such dependencies exist, you will need to
		update the SDK Tools package of the SDK after installing the new revision of
		ADT. To update the SDK Tools package, use the Android SDK Manager, as
		described in <a href="{@docRoot}sdk/exploring.html">Exploring the SDK</a>.</p>

		<p>To learn about new features of each ADT revision and also any dependencies on
		the SDK Tools, see the listings in the <a href="#notes">Revisions</a>
		section. To determine the version currently installed, open the
		Eclipse Installed Software window using <strong>Help</strong>
		> <strong>Software Updates</strong> and refer to the version listed for
		"Android Development Tools".</p>

		<p>Follow the steps below to check whether an update is available and, if so,
		to install it. </p>

		<ol>
		<li>Select <strong>Help</strong> > <strong>Check for Updates</strong>.
		<p>If there are no updates available, a dialog will say so and you're done.</p></li>
		<li>If there are updates available, select Android DDMS, Android Development Tools,
		and Android Hierarchy Viewer, then click <strong>Next</strong>.</li>
		<li>In the Update Details dialog, click <strong>Next</strong>.</li>
		<li>Read and accept the license agreement and then click <strong>Finish</strong>.
		This will download and install the latest version of Android DDMS and
		Android Development Tools.</li>
		<li>Restart Eclipse.</li>
		</ol>


		<p>If you encounter problems during the update, remove the existing ADT plugin from Eclipse, then
		perform a fresh installation, using the instructions for <a href="#installing">Installing the ADT
		Plugin</a>.</p>



		<h2 id="Troubleshooting">Troubleshooting</h2>
		<h2 id="Troubleshooting">Troubleshooting Installation</h2>

		<p> If you are having trouble downloading the ADT plugin after following the
		steps above, here are some suggestions: </p>