Skip to content

Commit 6e8d6bd

Browse files
scottamainAndroid (Google) Code Review
authored andcommitted
Merge "docs: Update various SDK docs for GB platform and tools" into gingerbread
2 parents 5ccbe05 + 06cf15e commit 6e8d6bd

File tree

3 files changed

+147
-127
lines changed

3 files changed

+147
-127
lines changed

docs/html/sdk/adding-components.jd

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page.title=Adding SDK Components
66
<div id="qv">
77
<h2>Quickview</h2>
88
<ul>
9-
<li>Use the Android SDK and AVD Manager to
9+
<li>Use the Android SDK and AVD Manager to
1010
set up your SDK and keep it up-to-date.</li>
1111
</ul>
1212

@@ -25,7 +25,7 @@ page.title=Adding SDK Components
2525
<p>Adding and updating components in your Android SDK is fast and easy. To
2626
perform an update, use the <strong>Android SDK and AVD Manager</strong> to
2727
install or update the individual SDK components that you need. The Android SDK
28-
and AVD Manager tool is included in the <a href="index.html">Android SDK
28+
and AVD Manager tool is included in the <a href="index.html">Android SDK
2929
download</a>.</p>
3030

3131
<p>It only takes a couple of clicks to install individual versions of the
@@ -53,19 +53,19 @@ a new version of the platform. See the revisions listed in the <a
5353
href="{@docRoot}sdk/tools-notes.html">SDK Tools</a> document for ADT
5454
Plugin compatibility.</p>
5555

56-
<div style="TEXT-ALIGN:left; width:600px;">
57-
<img src="{@docRoot}images/sdk_manager_packages.png"
58-
style="padding-bottom:0;margin-bottom:0;" />
56+
<div style="TEXT-ALIGN:left; width:600px;">
57+
<img src="{@docRoot}images/sdk_manager_packages.png"
58+
style="padding-bottom:0;margin-bottom:0;" />
5959
<p class="caption" style="margin:0 0 1.5em 1em;padding:0 0 0
60-
1em;"><strong>Figure 1.</strong> The Android SDK and AVD Manager's
60+
1em;"><strong>Figure 1.</strong> The Android SDK and AVD Manager's
6161
<strong>Available Packages</strong>
6262
panel, which shows the SDK components that are
6363
available for you to download into your environment. </p>
64-
</div>
64+
</div>
6565

6666
<h2 id="launching">Launching the Android SDK and AVD Manager</h2>
6767

68-
<p>The Android SDK and AVD Manager is the tool that you use to install and
68+
<p>The Android SDK and AVD Manager is the tool that you use to install and
6969
upgrade SDK components in your development environment. </p>
7070

7171
<p>You can access the tool in any of three ways:</p>
@@ -83,15 +83,15 @@ follow these steps to access the Android SDK and AVD Manager tool:</p>
8383

8484
<ol>
8585
<li>Open Eclipse</li>
86-
<li>Select <strong>Window</strong> &gt; <strong>Android SDK and AVD
86+
<li>Select <strong>Window</strong> &gt; <strong>Android SDK and AVD
8787
Manager</strong>.</li>
8888
</ol>
8989

90-
<h4>Launching from the setup script (Windows only)</h4>
90+
<h4>Launching from the SDK Manager script (Windows only)</h4>
9191

9292
<p>For Windows only, the SDK includes a script that invokes the Android SDK and
93-
AVD Manager. To launch the tool using the script, double-click "SDK
94-
Setup.exe" at the root of the the SDK directory.</p>
93+
AVD Manager. To launch the tool using the script, double-click {@code SDK
94+
Manager.exe} at the root of the the SDK directory.</p>
9595

9696
<h4>Launching from a command line</h4>
9797

@@ -100,37 +100,39 @@ and AVD Manager tool from the command line: </p>
100100

101101
<ol>
102102
<li>Navigate to the <code>&lt;<em>sdk</em>&gt;/tools/</code> directory.</li>
103-
<li>Execute the {@code android} tool command with no options.
103+
<li>Execute the {@code android} tool command with no options.
104104
<pre style="width:400px">$ android</pre></li>
105105
</ol>
106106

107107

108108
<h2 id="InstallingComponents">Installing SDK Components</h2>
109109

110-
<p class="caution"><strong>Important:</strong> Before you install SDK components,
111-
we recommend that you disable any antivirus programs that may be running on
112-
your computer.</p>
110+
<p class="caution"><strong>Caution:</strong> Before you install SDK components,
111+
we recommend that you disable any antivirus software that may be running on
112+
your computer. There are cases in which antivirus software on Windows is known to interfere with the
113+
installation process, so we suggest you disable your antivirus until installation is
114+
complete.</p>
113115

114116
<p>Follow these steps to install new SDK components in your environment:</p>
115117

116118
<ol>
117119
<li>Launch the Android SDK and AVD Manager as described in the section above.</li>
118120
<li>Select <strong>Available Packages</strong> in the left panel.
119-
This will reveal all of the components that are currently available for download
121+
This will reveal all of the components that are currently available for download
120122
from the SDK repository.</li>
121123
<li>Select the component(s) you'd like to install and click <strong>Install
122-
Selected</strong>. If you aren't sure which packages to select, read <a
124+
Selected</strong>. If you aren't sure which packages to select, read <a
123125
href="installing.html#which">Which components do I need?</a>.</li>
124126
<li>Verify and accept the components you want and click <strong>Install
125127
Accepted</strong>. The components will now be installed into your existing
126128
Android SDK directories.</li>
127129
</ol>
128130

129-
<p>New platforms are automatically saved into the
131+
<p>New platforms are automatically saved into the
130132
<code>&lt;<em>sdk</em>&gt;/platforms/</code> directory of your SDK;
131133
new add-ons are saved in the <code>&lt;<em>sdk</em>&gt;/add-ons/</code>
132-
directory; samples are saved in the
133-
<code>&lt;<em>sdk</em>&gt;/samples/android-&lt;<em>level</em>&gt;/</code>;
134+
directory; samples are saved in the
135+
<code>&lt;<em>sdk</em>&gt;/samples/android-&lt;<em>level</em>&gt;/</code>;
134136
and new documentation is saved in the existing
135137
<code>&lt;<em>sdk</em>&gt;/docs/</code> directory (old docs are replaced).</p>
136138

@@ -184,10 +186,10 @@ if there is dependency that you need to address. </p>
184186
<h2 id="AddingSites">Adding New Sites</h2>
185187

186188
<p>By default, <strong>Available Packages</strong> only shows the default
187-
repository site, which offers platforms, SDK tools, documentation, the
188-
Google APIs Add-on, and other components. You can add other sites that host
189+
repository site, which offers platforms, SDK tools, documentation, the
190+
Google APIs Add-on, and other components. You can add other sites that host
189191
their own Android SDK add-ons, then download the SDK add-ons
190-
from those sites.</p>
192+
from those sites.</p>
191193

192194
<p>For example, a mobile carrier or device manufacturer might offer additional
193195
API libraries that are supported by their own Android-powered devices. In order
@@ -199,7 +201,7 @@ Manager:</p>
199201

200202
<ol>
201203
<li>Select <strong>Available Packages</strong> in the left panel.</li>
202-
<li>Click <strong>Add Site</strong> and enter the URL of the
204+
<li>Click <strong>Add Site</strong> and enter the URL of the
203205
{@code repository.xml} file. Click <strong>OK</strong>.</li>
204206
</ol>
205207
<p>Any SDK components available from the site will now be listed under

docs/html/sdk/index.jd

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
page.title=Android SDK
22
sdk.redirect=0
33

4-
sdk.win_download=android-sdk_r07-windows.zip
5-
sdk.win_bytes=23669664
6-
sdk.win_checksum=69c40c2d2e408b623156934f9ae574f0
4+
sdk.win_installer=installer_r08-windows.exe
5+
sdk.win_installer_bytes=TODO
6+
sdk.win_installer_checksum=TODO
77

8-
sdk.mac_download=android-sdk_r07-mac_x86.zip
9-
sdk.mac_bytes=19229546
10-
sdk.mac_checksum=0f330ed3ebb36786faf6dc72b8acf819
8+
sdk.win_download=android-sdk_r08-windows.zip
9+
sdk.win_bytes=TODO
10+
sdk.win_checksum=TODO
1111

12-
sdk.linux_download=android-sdk_r07-linux_x86.tgz
13-
sdk.linux_bytes=17114517
14-
sdk.linux_checksum=e10c75da3d1aa147ddd4a5c58bfc3646
12+
sdk.mac_download=android-sdk_r08-mac_x86.zip
13+
sdk.mac_bytes=TODO
14+
sdk.mac_checksum=TODO
15+
16+
sdk.linux_download=android-sdk_r08-linux_x86.tgz
17+
sdk.linux_bytes=TODO
18+
sdk.linux_checksum=TODO
1519

1620
@jd:body
1721

1822

1923
<h2 id="quickstart">Quick Start</h2>
2024

21-
<p>The steps below provide an overview of how to get started with the Android
22-
SDK. For detailed instructions, start with the <a
23-
href="{@docRoot}sdk/installing.html">Installing the SDK</a> guide. </p>
24-
2525
<p><strong>1. Prepare your development computer</strong></p>
2626

2727
<p>Read the <a href="{@docRoot}sdk/requirements.html">System Requirements</a>
@@ -34,38 +34,37 @@ install the <a href="http://java.sun.com/javase/downloads/index.jsp">JDK</a>
3434

3535
<p><strong>2. Download and install the SDK starter package</strong></p>
3636

37-
<p>Select a starter package from the table at the top of this page and download
38-
it to your development computer. To install the SDK, simply unpack the starter
39-
package to a safe location and then add the location to your PATH. </p>
37+
<p>Download a starter package from the table above onto your development computer.
38+
If you're using Windows, we recommend that you download the installer (the {@code .exe} file),
39+
which will launch a Wizard to guide you through the installation and check your computer for
40+
required software. Otherwise, download the SDK starter package ({@code .zip} or {@code .tgz})
41+
appropriate for your system, unpack it to a safe location, then add the location to your PATH
42+
environment variable. </p>
4043

4144
<p><strong>3. Install the ADT Plugin for Eclipse</strong></p>
4245

43-
<p>If you are developing in Eclipse, set up a remote update site at
44-
<code>https://dl-ssl.google.com/android/eclipse/</code>. Install the Android
45-
Development Tools (ADT) Plugin, restart Eclipse, and set the "Android"
46-
preferences in Eclipse to point to the SDK install location. For detailed
47-
instructions, see <a href="{@docRoot}sdk/eclipse-adt.html">ADT Plugin
46+
<p>If you are developing in Eclipse, add a new remote update site with the URL
47+
<code>https://dl-ssl.google.com/android/eclipse/</code>. Install the Android
48+
Development Tools (ADT) Plugin from that site, restart Eclipse, and set the "Android"
49+
preferences in Eclipse to point to the Android SDK directory (installed in the previous step). For
50+
detailed instructions to setup Eclipse, see <a href="{@docRoot}sdk/eclipse-adt.html">ADT Plugin
4851
for Eclipse</a>.</p>
4952

5053
<p><strong>4. Add Android platforms and other components to your SDK</strong></p>
5154

52-
<p>Use the Android SDK and AVD Manager, included in the SDK starter package, to
53-
add one or more Android platforms (for example, Android 1.6 or Android 2.2) and
54-
other components to your SDK. If you aren't sure what to add, see <a
55+
<p>Launch the <em>Android SDK and AVD Manager</em> by executing {@code SDK Manager.exe} (Windows) or
56+
{@code android} (Mac/Linux) from the SDK's {@code tools/} directory (if you used the Windows
57+
installer, this is launched for you when the Wizard is complete). Add some Android platforms
58+
(such as Android 1.6 and Android 2.3) and other components (such as documentation) to your SDK. If
59+
you aren't sure what to add, see <a
5560
href="installing.html#which">Which components do I need?</a></p>
5661

57-
<p>To launch the Android SDK and AVD Manager on Windows, execute <code>SDK
58-
Setup.exe</code>, at the root of the SDK directory. On Mac OS X or Linux,
59-
execute the <code>android</code> tool in the <code>&lt;sdk&gt;/tools/</code>
60-
folder. For detailed instructions, see <a
61-
href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</p>
62-
6362
<p><strong>Done!</strong></p>
6463

65-
<p>If you are new to Android, you can use the <a
66-
href="{@docRoot}resources/tutorials/hello-world.html">Hello World</a> tutorial to
67-
get started quickly. <a href="{@docRoot}sdk/installing.html#NextSteps">Next
68-
Steps</a> offers other suggestions of how to begin.</p>
64+
<p>To write your first Android application, see the <a
65+
href="{@docRoot}resources/tutorials/hello-world.html">Hello World</a> tutorial. Also see <a
66+
href="{@docRoot}sdk/installing.html#NextSteps">Next
67+
Steps</a> for other suggestions about how to get started.</p>
6968

70-
<p>For a more detailed guide to installing and setting up the SDK, read <a
69+
<p>For a more detailed guide to installing and setting up the SDK, read <a
7170
href="installing.html">Installing the SDK</a>.</p>

0 commit comments

Comments
 (0)