Skip to content

Commit 6453dfb

Browse files
committed
update Download and installation guides for ADT Bundle
Change-Id: I59d3113d4caf937b13e10c50618a37ae86d4ae55
1 parent 4233c93 commit 6453dfb

File tree

11 files changed

+606
-411
lines changed

11 files changed

+606
-411
lines changed

docs/html/sdk/index.jd

Lines changed: 291 additions & 61 deletions
Large diffs are not rendered by default.
Lines changed: 20 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
page.title=Adding Platforms and Packages
2-
walkthru=1
32

43
@jd:body
54

@@ -9,8 +8,8 @@ walkthru=1
98
SDK package you've downloaded includes only the SDK Tools. To develop an Android app,
109
you also need to download at least one Android platform and the latest SDK Platform-tools.</p>
1110

12-
<p>You can update and install SDK packages at any time using the Android SDK Manager.</p>
13-
11+
<ol>
12+
<li>Launch the SDK Manager.
1413
<p>If you've used the Windows installer to install the SDK tools, you should already have the
1514
Android SDK Manager open. Otherwise, you can launch the Android SDK Manager in one of the following
1615
ways:</p>
@@ -20,64 +19,36 @@ SDK directory.</li>
2019
<li>On Mac or Linux, open a terminal and navigate to the <code>tools/</code> directory in the
2120
Android SDK, then execute <code>android sdk</code>.</li>
2221
</ul>
22+
</li>
2323

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

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

3235
<img src="/images/sdk_manager_packages.png" alt="" />
3336
<p class="img-caption"><strong>Figure 1.</strong> The Android SDK Manager shows the
3437
SDK packages that are available, already installed, or for which an update is available.</p>
3538

3639

3740

41+
<h3>Additional information</h3>
3842

39-
<h2 id="Recommended">Recommended Packages</h2>
40-
41-
<p>Here's an outlines of the packages required and those we recommend you use:
42-
</p>
43+
<p>For more information about using the SDK Manager and some of the available packages,
44+
see the <a href="{@docRoot}tools/help/sdk-manager.html">SDK Manager</a> document.</p>
4345

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

8054

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

docs/html/sdk/installing/bundle.jd

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
page.title=Setting Up the ADT Bundle
2+
3+
@jd:body
4+
5+
6+
<p>The ADT Bundle provides everything you need to start developing apps, including
7+
a powerful IDE based on Eclipse called ADT (Android Developer Tools).
8+
If you haven't already, go download the <a href="{@docRoot}sdk/index.html"
9+
>Android ADT Bundle</a>. (If you downloaded the SDK Tools only, for use with an
10+
existing IDE, you should instead read
11+
<a href="{@docRoot}sdk/installing/index.html">Setting Up an Existing IDE</a>.)</p>
12+
13+
<h3>Install the SDK and Eclipse IDE</h3>
14+
<ol>
15+
<li>Unpack the ZIP file
16+
(named {@code adt-bundle-&lt;os_platform>.zip}) and save it to an appropriate location,
17+
such as a "Development" directory in your home directory.</li>
18+
<li>Open the {@code adt-bundle-&lt;os_platform>/eclipse/} directory and launch
19+
<strong>eclipse</strong>.</li>
20+
</ol>
21+
22+
<p>That's it! The IDE is already loaded with the Android Developer Tools plugin and
23+
the SDK is ready to go. To start developing, read <a href="{@docRoot}training/basics/firstapp/index.html"
24+
>Building Your First App</a>.</p>
25+
26+
<p class="caution"><strong>Caution:</strong> Do not move any of the files or directories
27+
from the {@code adt-bundle-&lt;os_platform>} directory. If you move the {@code eclipse}
28+
or {@code sdk} directory, ADT will not be able to locate the SDK and you'll
29+
need to manually update the ADT preferences.</p>
30+
31+
<h3>Additional information</h3>
32+
33+
<p>As you continue developing apps, you may need to install additional versions
34+
of Android for the emulator and other packages such as the library for
35+
Google Play In-app Billing. To install more packages, use
36+
the <a href="{@docRoot}tools/help/sdk-manager.html">SDK Manager</a>.</p>
37+
38+
<p>Everything you need to develop Android apps is on this web site, including <a
39+
href="{@docRoot}design/index.html">design guidelines</a>,
40+
<a href="{@docRoot}training/index.html">developer training</a>, <a
41+
href="{@docRoot}reference/packages.html">API reference</a>, and information
42+
about how you can <a href="{@docRoot}distribute/index.html">distribute your app</a>.
43+
For additional resources about developing and distributing your app, see the
44+
<a href="{@docRoot}support.html">Developer Support Resources</a>.</p>

docs/html/sdk/installing/index.jd

Lines changed: 46 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,37 @@
1-
page.title=Installing the SDK
2-
walkthru=1
1+
page.title=Setting Up an Existing IDE
32

43
@jd:body
54

65

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

10-
<p>The SDK you've downloaded is not the complete SDK environment. It includes only the core SDK tools, which you can
10+
<p>The SDK Tools package is not the complete SDK environment. It includes only the core SDK tools, which you can
1111
use to download the rest of the SDK packages (such as the latest system image).</p>
1212

1313

1414
<div id="win" class="docs" style="display:none">
15-
15+
1616
<h3>Getting started on Windows</h3>
1717
<p>Your download package is an executable file that starts an installer. The installer checks your machine
1818
for required tools, such as the proper Java SE Development Kit (JDK) and installs it if necessary.
1919
The installer then saves the Android SDK Tools into a default location (or you can specify the location).</p>
2020

21-
<p>Make a note of the name and location of the SDK directory on your system&mdash;you will need to
21+
<ol>
22+
<li>Double-click the executable ({@code .exe} file) to start the install.</li>
23+
<li>Make a note of the name and location in which it saves the SDK on your system&mdash;you will need to
2224
refer to the SDK directory later, when setting up the ADT plugin and when using
23-
the SDK tools from the command line.</p>
24-
25-
<p>Once the tools are installed, the installer offers to start the Android SDK Manager. Start it and
26-
continue with the installation guide by clicking the
27-
<strong>Next</strong> link on the right.</p>
25+
the SDK tools from the command line.</li>
26+
<li>Once the installation completes. the installer offers to start the Android SDK Manager.
27+
If you'll be using Eclipse, <strong>do not</strong> start the Android SDK Manager,
28+
and instead move on to <a href="{@docRoot}sdk/installing/installing-adt.html"
29+
>Installing the Eclipse Plugin</a>.
30+
<p>If you're using a different IDE,
31+
start the SDK Manager and read <a href="{@docRoot}sdk/installing/adding-packages.html"
32+
>Adding Platforms and Packages</a>.</p>
33+
</li>
34+
</ol>
2835

2936
</div>
3037

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

3542
<h3>Getting started on Mac</h3>
3643

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

4149
<p>Make a note of the name and location of the SDK directory on your system&mdash;you will need to
4250
refer to the SDK directory later, when setting up the ADT plugin and when using
4351
the SDK tools from the command line.</p>
44-
45-
<p>Now continue with the installation guide by clicking the
46-
<strong>Next</strong> link on the right.</p>
52+
</li>
53+
<li>If you're using Eclipse, move on to <a href="{@docRoot}sdk/installing/installing-adt.html"
54+
>Installing the Eclipse Plugin</a>. Otherwise, if you're using a different IDE,
55+
read <a href="{@docRoot}sdk/installing/adding-packages.html"
56+
>Adding Platforms and Packages</a>.</li>
57+
</ol>
4758

4859
</div>
4960

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

5566
<h3>Getting started on Linux</h3>
5667

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

6173
<p>Make a note of the name and location of the SDK directory on your system&mdash;you will need to
6274
refer to the SDK directory later, when setting up the ADT plugin and when using
6375
the SDK tools from the command line.</p>
76+
</li>
77+
<li>If you're using Eclipse, move on to <a href="{@docRoot}sdk/installing/installing-adt.html"
78+
>Installing the Eclipse Plugin</a>. Otherwise, if you're using a different IDE,
79+
read <a href="{@docRoot}sdk/installing/adding-packages.html"
80+
>Adding Platforms and Packages</a>.</li>
81+
</ol>
6482

65-
<p>Now continue with the installation guide by clicking the
66-
<strong>Next</strong> link on the right.</p>
6783

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

69-
<h4 id="Troubleshooting">Troubleshooting Ubuntu</h4>
70-
88+
<div id="ubuntu-trouble" style="display:none">
7189
<ul>
7290
<li>If you need help installing and configuring Java on your
7391
development machine, you might find these resources helpful:
@@ -95,10 +113,12 @@ the SDK tools from the command line.</p>
95113
</ol>
96114
</li>
97115
</ul>
116+
</div><!-- end ubuntu trouble -->
117+
98118

99119
</div>
100120

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

103123
<script>
104124
var $osDocs;

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

Lines changed: 12 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
page.title=Installing the Eclipse Plugin
2-
walkthru=1
3-
adt.zip.version=20.0.3
4-
adt.zip.download=ADT-20.0.3.zip
5-
adt.zip.bytes=12390954
6-
adt.zip.checksum=869a536b1c56d0cd920ed9ae259ae619
2+
adt.zip.version=21.0.0
3+
adt.zip.download=ADT-21.0.0.zip
4+
adt.zip.bytes=13556487
5+
adt.zip.checksum=7db4eaae5df6a34fd853317a2bd8250b
76

87
@jd:body
98

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

19-
<p>If you will be developing in Eclipse with the ADT Plugin, first make sure that you have a
20-
suitable version of Eclipse
21-
installed on your computer as described by the
22-
<a href="{@docRoot}sdk/index.html#Requirements">system requirements</a>.</p>
23-
2418
<p>If you need to install Eclipse, you can download it from <a href=
25-
"http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a>.
26-
We recommend the "Eclipse Classic" version. Otherwise, you should use a Java or
27-
RCP version of Eclipse.</p>
19+
"http://eclipse.org/mobile/">eclipse.org/mobile</a>.</p>
2820

2921

3022
<p class="note"><strong>Note:</strong> If you prefer to work in a different IDE, you do not need to
3123
install Eclipse or ADT. Instead, you can directly use the SDK tools to build and
32-
debug your application. So if you're not using Eclipse, continue to the next page by clicking
33-
the <strong>Next</strong> link on the right.</p>
24+
debug your application.</p>
3425

3526

3627

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

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

78-
<p>If you haven't encountered any errors, you're done setting up ADT
79-
and can continue to <a href="{@docRoot}sdk/installing/next.html">Next Steps</a>.</p>
80-
81-
82-
83-
84-
<h2 id="Updating">Updating the ADT Plugin</h2>
85-
86-
<p>From time to time, a new revision of the ADT Plugin becomes available, with
87-
new features and bug fixes. Generally, when a new revision of ADT is available,
88-
you should update to it as soon as convenient. </p>
89-
90-
<p>In some cases, a new revision of ADT will have a dependency on a specific
91-
revision of the Android SDK Tools. If such dependencies exist, you will need to
92-
update the SDK Tools package of the SDK after installing the new revision of
93-
ADT. To update the SDK Tools package, use the Android SDK Manager, as
94-
described in <a href="{@docRoot}sdk/exploring.html">Exploring the SDK</a>.</p>
95-
96-
<p>To learn about new features of each ADT revision and also any dependencies on
97-
the SDK Tools, see the listings in the <a href="#notes">Revisions</a>
98-
section. To determine the version currently installed, open the
99-
Eclipse Installed Software window using <strong>Help</strong>
100-
&gt; <strong>Software Updates</strong> and refer to the version listed for
101-
"Android Development Tools".</p>
102-
103-
<p>Follow the steps below to check whether an update is available and, if so,
104-
to install it. </p>
105-
106-
<ol>
107-
<li>Select <strong>Help</strong> &gt; <strong>Check for Updates</strong>.
108-
<p>If there are no updates available, a dialog will say so and you're done.</p></li>
109-
<li>If there are updates available, select Android DDMS, Android Development Tools,
110-
and Android Hierarchy Viewer, then click <strong>Next</strong>.</li>
111-
<li>In the Update Details dialog, click <strong>Next</strong>.</li>
112-
<li>Read and accept the license agreement and then click <strong>Finish</strong>.
113-
This will download and install the latest version of Android DDMS and
114-
Android Development Tools.</li>
115-
<li>Restart Eclipse.</li>
116-
</ol>
11773

11874

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

12376

12477

125-
<h2 id="Troubleshooting">Troubleshooting</h2>
78+
<h2 id="Troubleshooting">Troubleshooting Installation</h2>
12679

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

docs/html/sdk/installing/next.jd

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
page.title=Next Steps
2-
walkthru=1
32

43
@jd:body
54

0 commit comments

Comments
 (0)