blob: c3afebd7ff38c8443143bc1696b7695140f29754 [file] [log] [blame]
Dirk Dougherty7b229ef2010-03-26 17:32:26 -07001page.title=ADT Plugin for Eclipse
Dirk Doughertyee58d1b2009-10-16 15:25:15 -07002sdk.preview=0
Dirk Dougherty9a97aaf2010-09-23 11:48:54 -07003adt.zip.version=0.9.9
4adt.zip.download=ADT-0.9.9.zip
5adt.zip.bytes=8301681
6adt.zip.checksum=7deff0c9b25940a74cea7a0815a3bc36
Dirk Doughertyee58d1b2009-10-16 15:25:15 -07007
8@jd:body
9
10<div id="qv-wrapper">
11<div id="qv">
12
13 <h2>In this document</h2>
14 <ol>
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070015 <li><a href="#notes">Revisions</a></li>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070016 <li><a href="#installing">Installing the ADT Plugin</a>
17 <ol>
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070018 <li><a href="#preparing">Preparing for Installation</a></li>
19 <li><a href="#downloading">Downloading the ADT Plugin</a>
20 <li><a href="#configuring">Configuring the ADT Plugin</a></li>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070021 <li><a href="#troubleshooting">Troubleshooting</a></li>
22 </ol>
23 </li>
24 <li><a href="#updating">Updating the ADT Plugin</a></li>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070025 </ol>
26
27</div>
28</div>
29
Scott Main081127b2010-10-29 15:56:27 -070030<p>Android Development Tools (ADT) is a plugin for the Eclipse IDE
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070031that is designed to give you a powerful, integrated environment in which
32to build Android applications. </p>
Dirk Doughertybf15ce62009-10-23 19:17:12 -070033
Scott Main13244e52010-01-19 11:12:07 -080034<p>ADT extends the capabilities of Eclipse to let you quickly set up new Android
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070035projects, create an application UI, add components based on the Android
Dirk Doughertybf15ce62009-10-23 19:17:12 -070036Framework API, debug your applications using the Android SDK tools, and even
37export signed (or unsigned) APKs in order to distribute your application.</p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070038
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070039<p>Developing in Eclipse with ADT is highly recommended and is the fastest way
40to get started. With the guided project setup it provides, as well as tools
41integration, custom XML editors, and debug ouput pane, ADT gives you an
42incredible boost in developing Android applications. </p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070043
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070044<p>This document provides step-by-step instructions on how to download the ADT
45plugin and install it into your Eclipse development environment. Note that
46before you can install or use ADT, you must have compatible versions of both the
47Eclipse IDE and the Android SDK installed. For details, make sure to read <a
48href="#installing">Installing the ADT Plugin</a>, below. </p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070049
Scott Main081127b2010-10-29 15:56:27 -070050<p>If you are already using ADT, this document also provides instructions on
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070051how to update ADT to the latest version or how to uninstall it, if necessary.
52</p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070053
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070054<h2 id="notes">Revisions</h2>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070055
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070056<p>The sections below provide notes about successive releases of
57the ADT Plugin, as denoted by revision number. </p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -070058
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070059<script type="text/javascript">
60function toggleDiv(link) {
61 var toggleable = $(link).parent();
62 if (toggleable.hasClass("closed")) {
63 //$(".toggleme", toggleable).slideDown("fast");
64 toggleable.removeClass("closed");
65 toggleable.addClass("open");
66 $(".toggle-img", toggleable).attr("title", "hide").attr("src", (toRoot + "assets/images/triangle-opened.png"));
67 } else {
68 //$(".toggleme", toggleable).slideUp("fast");
69 toggleable.removeClass("open");
70 toggleable.addClass("closed");
71 $(".toggle-img", toggleable).attr("title", "show").attr("src", (toRoot + "assets/images/triangle-closed.png"));
72 }
73 return false;
74}
75</script>
76<style>
77.toggleable {
78padding: .25em 1em;
79}
80.toggleme {
81 padding: 1em 1em 0 2em;
82 line-height:1em;
83}
84.toggleable a {
85 text-decoration:none;
86}
Dirk Dougherty0d1b0812010-04-07 17:05:16 -070087.toggleme a {
88 text-decoration:underline;
89}
Dirk Dougherty7b229ef2010-03-26 17:32:26 -070090.toggleable.closed .toggleme {
91 display:none;
92}
93#jd-content .toggle-img {
94 margin:0;
95}
96</style>
97
Dirk Dougherty022171b2010-07-30 19:24:17 -070098
Dirk Dougherty0d1b0812010-04-07 17:05:16 -070099<div class="toggleable opened">
100 <a href="#" onclick="return toggleDiv(this)">
Dirk Dougherty022171b2010-07-30 19:24:17 -0700101 <img src="{@docRoot}assets/images/triangle-opened.png" class="toggle-img" height="9px" width="9px" />
Scott Mainc0c0c422010-11-05 15:23:36 -0700102ADT 8.0</a> <em>(November 2010)</em>
Dirk Dougherty9a97aaf2010-09-23 11:48:54 -0700103 <div class="toggleme">
104
Scott Mainc0c0c422010-11-05 15:23:36 -0700105<dl>
Dirk Dougherty9a97aaf2010-09-23 11:48:54 -0700106
Scott Mainc0c0c422010-11-05 15:23:36 -0700107<dt>Dependencies:</dt>
108
109<p><p>ADT 8.0 is designed for use with SDK Tools r8. If you haven't
110already installed SDK Tools r8 into your SDK, use the Android SDK and AVD Manager to do
111so.</p></dd>
112
113<dt>General notes:</dt>
114<dd>
115<ul>
116 <li>New version number scheme that follows the SDK Tools revision number. The major version
117number for your ADT plugin should now always match the revision number of your SDK Tools. For
118example, ADT 8.x is for SDK Tools r8.</li>
119 <li>Support for true debug build. You no longer need to change the value of the
120 <code>debuggable</code> attribute in the Android Manifest.
121 <p>Incremental builds automatically insert <code>debuggable="true"</code>, but if you perform
122 "export signed/unsigned application package", ADT does <em>not</em> insert it.
123 If you manually set <code>debuggable="true"</code> in the manifest file, then release builds will
124 actually create a debug build (it does not remove it if you placed it there).</p></li>
125 <li>Automatic <a href="{@docRoot}guide/developing/tools/proguard.html">Proguard</a> support in
126release builds. For it to work, you need to have a <code>proguard.config</code>
127 property in the <code>default.properties</code> file that points to a proguard config file.</li>
128 <li>Completely rewritten Visual Layout Editor. (This is still a work in progress.) Now includes:
129 <ul>
130 <li>Full drag and drop from palette to layout for all Layout classes.</li>
131 <li>Move widgets inside a Layout view, from one Layout view to another and from one layout file to another.</li>
132 <li>Contextual menu with enum/flag type properties.</li>
133 <li>New zoom controls.</li>
134 </ul></li>
135 <li>New HierarchyViewer plug-in integrated in Eclipse.</li>
136 <li>Android launch configurations don't recompile the whole workspace on launch anymore.</li>
137 <li><code>android.jar</code> source and javadoc location can now be configured.</li>
Dirk Dougherty9a97aaf2010-09-23 11:48:54 -0700138</ul>
139</dd>
Scott Mainc0c0c422010-11-05 15:23:36 -0700140</dl>
141 </div>
142</div>
143
144
145<div class="toggleable closed">
146 <a href="#" onclick="return toggleDiv(this)">
147 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
148ADT 0.9.9</a> <em>(September 2010)</em>
149 <div class="toggleme">
Dirk Dougherty9a97aaf2010-09-23 11:48:54 -0700150
151<dl>
152
153<dt>Dependencies:</dt>
154
155<dd><p>ADT 0.9.9 replaces ADT 0.9.8 and is designed for use with SDK Tools r7
156and later. ADT 0.9.9 includes the ADT 0.9.8 features as well as an important
157bugfix, so we recommend that you upgrade as soon as possible. If you haven't
158already installed SDK Tools r7 into your SDK, use the Android SDK Manager to do
159so.</p></dd>
160
161<dt>General notes:</dt>
162<dd>
163<ul>
164<li>Fixes a problem in project import, in which source files were deleted in some cases.</li>
165<li>Includes all other ADT 0.9.8 features (see below).</li>
166</ul>
167</dd>
168</dl>
169 </div>
170</div>
171
172<div class="toggleable closed">
173 <a href="#" onclick="return toggleDiv(this)">
174 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
Dirk Dougherty74a74d32010-09-09 18:40:13 -0700175ADT 0.9.8</a> <em>(September 2010)</em>
Dirk Dougherty022171b2010-07-30 19:24:17 -0700176 <div class="toggleme">
177
178
179</ul>
180</dd>
181
182<dl>
183
184<dt>Dependencies:</dt>
185
Dirk Dougherty9a97aaf2010-09-23 11:48:54 -0700186<dd><p>ADT 0.9.8 is now deprecated. Please use ADT 0.9.9 instead.</p></dd>
Dirk Dougherty022171b2010-07-30 19:24:17 -0700187
188<dt>General notes:</dt>
189<dd>
190<ul>
191<li>Adds a new Action, "Rename Application Package", to the Android Tools
192contextual menu. The Action does a full application package refactoring.
193<li>Adds support for library projects that don't have a source folder
194called <code>src/</code>. There is now support for any number of source folders,
195with no name restriction. They can even be in subfolder such as
196<code>src/java</code>. If you are already working with library projects created
Scott Main081127b2010-10-29 15:56:27 -0700197in ADT 0.9.7, see <a
Dirk Dougherty022171b2010-07-30 19:24:17 -0700198href="{@docRoot}guide/developing/eclipse-adt.html#libraryMigrating">Migrating
199library projects to ADT 0.9.8</a> for important information about moving
200to the new ADT environment.</li>
201<li>Adds support for library projects that depend on other library
202projects.</li>
203<li>Adds support for additional resource qualifiers:
204<code>car</code>/<code>desk</code>, <code>night</code>/<code>notnight</code> and
205<code>navexposed</code>/<code>navhidden</code>.</li>
206<li>Adds more device screen types in the layout editor. All screen
Scott Main081127b2010-10-29 15:56:27 -0700207resolution/density combinations listed in the <a
Dirk Dougherty022171b2010-07-30 19:24:17 -0700208href="{@docRoot}guide/practices/screens_support.html#range">Supporting
209Multiple Screens</a> are now available.</li>
210<li>Fixes problems with handling of library project names that
211contain characters that are incompatible with the Eclipse path variable.
212Now properly sets up the link between the main project and the library
213project.</li>
214</ul>
215</dd>
216</dl>
217 </div>
218</div>
219
220
221<div class="toggleable closed">
222 <a href="#" onclick="return toggleDiv(this)">
Dirk Dougherty0d1b0812010-04-07 17:05:16 -0700223 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
Dirk Doughertyc7c7afd2010-05-24 09:07:14 -0700224ADT 0.9.7</a> <em>(May 2010)</em>
Dirk Dougherty0d1b0812010-04-07 17:05:16 -0700225 <div class="toggleme">
226
227<dl>
228<dt>Library projects:</dt>
229<dd>
230<p>The ADT Plugin now supports the use of <em>library projects</em> during
231development, a capability that lets you store shared Android application
232code and resources in a separate development project. You can then reference the
233library project from other Android projects and, at build time, the tools
234compile the shared code and resources as part of the dependent applications.
235More information about this feature is available in the <a
Scott Main081127b2010-10-29 15:56:27 -0700236href="{@docRoot}guide/developing/eclipse-adt.html#libraryProject">Developing
Dirk Dougherty0d1b0812010-04-07 17:05:16 -0700237in Eclipse with ADT</a> document. </p>
Scott Main081127b2010-10-29 15:56:27 -0700238<p>If you are not developing in Eclipse, <a
239href="tools-notes.html">SDK Tools r6</a> provides the equivalent library
Dirk Dougherty0d1b0812010-04-07 17:05:16 -0700240project support through the Ant build system.</p>
241</dd>
242</dl>
243 </div>
244</div>
245
Dirk Dougherty022171b2010-07-30 19:24:17 -0700246
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700247<div class="toggleable closed">
248 <a href="#" onclick="return toggleDiv(this)">
249 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
250ADT 0.9.6</a> <em>(March 2010)</em>
251 <div class="toggleme">
252
253<dl>
254<dt>Dependencies:</dt>
255
Scott Main081127b2010-10-29 15:56:27 -0700256<dd><p>ADT 0.9.6 is designed for use with SDK Tools r5 and later. Before
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700257updating to ADT 0.9.6, we highly recommend that you use the Android SDK and
258AVD Manager to install SDK Tools r5 into your SDK.</p></dd>
259
260<dt>General Notes:</dt>
261<dd>
262<ul>
263<li>Editing <code>default.properties</code> outside of Eclipse will now
264automatically update the project.</li>
265<li>Loads the SDK content only when a project requires it. This will make
266Eclipse use less resources when the SDK contains many versions of Android.</li>
267<li>Resolves potential deadlock between modal dialogs, when launching ADT the
268first time with the SDK Usage panel.</li>
269<li>Fixes issues with the New Project Wizard when selecting samples.</li>
270</ul>
271</dd>
272<dt>AVD/SDK Manager:</dt>
273<dd>
274<ul>
275<li>Adds support for platform samples components.</li>
276<li>Improves support for dependency between components.</li>
277<li>AVDs now sorted by API level.</li>
278<li>The AVD creation dialog now enforces a minimum SD card size of 9MB.</li>
279<li>Prevents deletion of running AVDs.</li>
280</ul>
281</dd>
282<dt>DDMS:</dt>
283<dd>
284<ul>
285<li>DDMS plug-in now contains the Allocation Tracker view.</li>
286<li>New action in the Logcat view: "Go to problem" lets you go directly from an
287exception trace output to the code.</li>
288</ul>
289</dd>
290<dt>Editors:</dt>
291<dd>
292<ul>
293<li>Explode mode in the Visual Layout Editor adds a margin to all layout objects
294so that it's easier to see embedded or empty layouts.</li>
295<li>Outline mode in the Visual Layout Editor draws layout outline to make it
296easier to see layout objects.</li>
297<li>Several fixes in the configuration selector of the Visual Layout
298Editor.</li>
299</ul>
300</dd>
301<dt>Application launching:</dt>
302<dd>
303<ul>
304<li>Applications launched from ADT now behave as if they were clicked from the
305Home screen.</li>
306<li>Fixes issue where add-on with no optional library would not show up as valid
307targets for application launches.</li>
308<li>Resolves possible crash when launching applications.</li>
309</ul>
310</dd>
311</dl>
312 </div>
313</div>
314
315<div class="toggleable closed">
316 <a href="#" onclick="return toggleDiv(this)">
317 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
318ADT 0.9.5</a> <em>(December 2009)</em>
319 <div class="toggleme">
320<dl>
321<dt>Dependencies:</dt>
322
323<dd><p>ADT 0.9.5 requires features provided in SDK Tools r4 or higher. If you install
324ADT 0.9.5, which is highly recommended, you should use the Android SDK and AVD
325Manager to download thye latest SDK Tools into your SDK. For more information,
326see <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</p>
327</dd>
328
329<dt>General Notes:</dt>
330<dd>
331<ul>
332<li>AVD Launch dialog now shows scale value.</li>
333<li>Fixes potential NPE in SDK Manager on AVD launch, for older AVD with no skin name specified.</li>
334<li>Fixes XML validation issue in on older Java versions.</li>
335<li>.apk packaging now properly ignores vi swap files as well as hidden files.</li>
336</ul>
337</dd>
338</dl>
339 </div>
340</div>
341
342<div class="toggleable closed">
343 <a href="#" onclick="return toggleDiv(this)">
344 <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" />
345ADT 0.9.4</a> <em>(October 2009)</em>
346 <div class="toggleme">
347<dl>
348<dt>Dependencies:</dt>
349
350<dd><p>ADT 0.9.4 requires features provided in SDK Tools r3 or higher. If you install
351ADT 0.9.4, which is highly recommended, you should use the Android SDK and AVD
352Manager to download the latest SDK Tools into your SDK. For more information,
353see <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</p>
354</dd>
355
356<dt>Project Creation Wizard:</dt>
357<dd>
358<ul>
359<li>New option to create a project from a sample by choosing it from a list.</li>
360</ul>
361</dd>
362
363<dt>Layout Editor:</dt>
364<dd>
365<ul>
366<li>Improved Configuration selector that lets you see how your layout will
367render on different devices. Default device descriptions include ADP1
368and Google Ion, while SDK add-ons can also provide new descriptions.
369A new UI allows you to create custom descriptions.</li>
370<li>Adds a new clipping toggle, to let you see your full layout even if it's
371bigger than the screen.</li>
372</ul>
373</dd>
374
375<dt>DDMS Integration:</dt>
376<dd>
377<ul>
378<li>Includes the improvements from the standlone DDMS, revision 3.</li>
379<li>Adds an option to open HPROF files into eclipse instead of writing them on
Scott Main081127b2010-10-29 15:56:27 -0700380disk. If a profiler such as MAT (<a href="http://eclipse.org/mat">Memory Analyzer
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700381Tool</a>) is installed, it'll open the file.</li>
382</ul>
383</dd>
384
385<dt>Android SDK and AVD Manager integration:</dt>
386<dd>
387<ul>
Scott Main081127b2010-10-29 15:56:27 -0700388<li>Includes the improvements from the standalone Android SDK and AVD Manager,
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700389revision 3.</li>
390</ul>
391</dd>
392</dl>
393 </div>
394</div>
395
Scott Main77847a32010-11-09 16:41:32 -0800396
397
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700398<h2 id="installing">Installing the ADT Plugin</h2>
399
400<p>The sections below provide instructions on how to download and install
401ADT into your Eclipse environment. If you encounter problems, see the <a
402href="#troubleshooting">Troubleshooting</a> section.</p>
403
Scott Main77847a32010-11-09 16:41:32 -0800404
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700405<h3 id="preparing">Preparing Your Development Computer</h3>
406
407<p>ADT is a plugin for the Eclipse IDE. Before you can install or use ADT,
408you must have a compatible version of Eclipse installed on your development
409computer. </p>
410
411<ul>
412<li>If Eclipse is already installed on your computer, make sure that it is
413a version that is compatible with ADT and the Android SDK. Check the <a
414href="requirements.html">System Requirements</a> document for
415a list of Eclipse versions that are compatible with the Android SDK.</li>
416<li>If you need to install or update Eclipse, you can download it from this
417location:
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700418
Dirk Dougherty22558d02009-12-10 16:25:06 -0800419<p style="margin-left:2em;"><a href=
420"http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a>
421</p>
422
Scott Main77847a32010-11-09 16:41:32 -0800423<p>For Eclipse 3.5 or newer, the "Eclipse Classic" version is recommended. Otherwise, a Java or RCP
424version of Eclipse is recommended.</p></li>
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700425</ul>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700426
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700427<p>Additionally, before you can configure or use ADT, you must install the
428Android SDK starter package, as described in <a
Robert Lyef13d022010-07-12 14:32:22 -0700429href="installing.html#Installing">Downloading the SDK Starter Package</a>.
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700430Specifically, you need to install a compatible version of the Android SDK Tools
431and at least one development platform. To simplify ADT setup, we recommend
432installing the Android SDK prior to installing ADT. </p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700433
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700434<p>When your Eclipse and Android SDK environments are ready, continue with the
435ADT installation as described in the steps below. </p>
436
437<h3 id="downloading">Downloading the ADT Plugin</h3>
438
439<p>Use Update Manager feature of your Eclipse installation to install the latest
440revision of ADT on your development computer.<p>
441
442<p>Assuming that you have a compatible version of the Eclipse IDE installed, as
443described in <a href="#preparing">Preparing for Installation</a>, above, follow
444these steps to download the ADT plugin and install it in your Eclipse
445environment. </p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700446
447<table style="font-size:100%">
Scott Main77847a32010-11-09 16:41:32 -0800448<tr><th>Eclipse 3.5 (Galileo) and 3.6 (Helios)</th><th>Eclipse 3.4 (Ganymede)</th></tr>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700449<tr>
450<td width="45%">
Scott Main77847a32010-11-09 16:41:32 -0800451<!-- 3.5+ steps -->
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700452<ol>
Scott Main77847a32010-11-09 16:41:32 -0800453 <li>Start Eclipse, then select <strong>Help</strong> &gt; <strong>Install New
454Software...</strong>.</li>
455 <li>Click <strong>Add</strong>, in the top-right corner.</li>
456 <li>In the Add Repository dialog that appears, enter "ADT Plugin" for the <em>Name</em> and the
457following URL for the <em>Location</em>:
458 <pre>https://dl-ssl.google.com/android/eclipse/</pre>
Scott Main13244e52010-01-19 11:12:07 -0800459 <p>Note: If you have trouble acquiring the plugin, try using "http" in the Location URL,
Scott Main081127b2010-10-29 15:56:27 -0700460 instead of "https" (https is preferred for security reasons).</p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700461 <p>Click <strong>OK</strong>.</p></li>
Scott Main77847a32010-11-09 16:41:32 -0800462 <li>In the Available Software dialog, select
463the checkbox next to Developer Tools and click <strong>Next</strong>.</li>
464 <li>In the next window, you'll see a list of the tools to be downloaded. Click
465<strong>Next</strong>. </li>
466 <li>Read and accept the license agreements, then click <strong>Finish</strong>.</li>
467 <li>When the installation completes, restart Eclipse. </li>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700468</ol>
469
470</td>
Scott Main77847a32010-11-09 16:41:32 -0800471<td width="50%">
472
473<!-- 3.4 steps -->
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700474<ol>
Scott Main77847a32010-11-09 16:41:32 -0800475 <li>Start Eclipse, then select <strong>Help</strong> &gt; <strong>Software Updates...</strong>.
476In the dialog that appears, click the <strong>Available Software</strong> tab.</li>
477 <li>Click <strong>Add Site</strong>.</li>
478 <li>In the Add Site dialog that appears, enter this URL in the "Location" field:
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700479 <pre>https://dl-ssl.google.com/android/eclipse/</pre>
Scott Main13244e52010-01-19 11:12:07 -0800480 <p>Note: If you have trouble acquiring the plugin, you can try
Scott Main081127b2010-10-29 15:56:27 -0700481 using "http" in the URL, instead of "https" (https is preferred for
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700482 security reasons).</p>
483 <p>Click <strong>OK</strong>.</p>
484 </li>
Scott Main77847a32010-11-09 16:41:32 -0800485 <li>Back in the Available Software view, you should see the plugin listed by the URL,
486 with "Developer Tools" nested within it. Select the checkbox next to Developer Tools,
487 which will automatically select the nested tools. Then click
488 <strong>Install</strong></li>
489 <li>On the subsequent Install window, all of the included tools
490 should be checked. Click <strong>Next</strong>. </li>
491 <li>Read and accept the license agreements, then click <strong>Finish</strong>.</li>
492 <li>When the installation completes, restart Eclipse. </li>
Scott Main081127b2010-10-29 15:56:27 -0700493
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700494</ol>
495</td>
496</tr>
497</table>
498
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700499<h3 id="preparing">Configuring the ADT Plugin</h3>
500
Dirk Dougherty4b4af992010-09-13 11:24:06 -0700501<p>Once you've successfully downloaded ADT as described above, the next step
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700502is to modify your ADT preferences in Eclipse to point to the Android SDK directory:</p>
503
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700504<ol>
505 <li>Select <strong>Window</strong> &gt; <strong>Preferences...</strong> to open the Preferences
506 panel (Mac OS X: <strong>Eclipse</strong> &gt; <strong>Preferences</strong>).</li>
507 <li>Select <strong>Android</strong> from the left panel. </li>
Scott Main081127b2010-10-29 15:56:27 -0700508 <li>For the <em>SDK Location</em> in the main panel, click <strong>Browse...</strong> and
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700509 locate your downloaded SDK directory. </li>
510 <li>Click <strong>Apply</strong>, then <strong>OK</strong>.</li>
511</ol>
512
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700513<p>Done! If you haven't encountered any problems, then the installation is
Scott Main081127b2010-10-29 15:56:27 -0700514complete. If you're installing the Android SDK for the first time, return to <a
515href="{@docRoot}sdk/installing.html#InstallingADT">Installing the SDK</a> to complete your setup.
516</p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700517
518
519<h3 id="troubleshooting">Troubleshooting ADT Installation</h3>
520
521<p> If you are having trouble downloading the ADT plugin after following the
522steps above, here are some suggestions: </p>
523
524<ul>
525 <li>If Eclipse can not find the remote update site containing the ADT plugin,
526try changing the remote site URL to use http, rather than https. That is, set
527the Location for the remote site to:
Scott Main081127b2010-10-29 15:56:27 -0700528<pre>http://dl-ssl.google.com/android/eclipse/</pre></li>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700529<li>If you are behind a firewall (such as a corporate firewall), make sure that
Scott Main77847a32010-11-09 16:41:32 -0800530you have properly configured your proxy settings in Eclipse. In Eclipse,
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700531you can configure proxy information from the main Eclipse menu in
532<strong>Window</strong> (on Mac OS X, <strong>Eclipse</strong>) &gt;
533<strong>Preferences</strong> &gt; <strong>General</strong> &gt; <strong>Network
534Connections</strong>.</li>
535</ul>
536
537<p> If you are still unable to use Eclipse to download the ADT plugin as a
538remote update site, you can download the ADT zip file to your local machine and
539manually install it:</p>
540
541<ol>
542 <li>Download the current ADT Plugin zip file from the table below (do not unpack it).
543
544 <table class="download">
545 <tr>
546 <th>Name</th>
547 <th>Package</th>
548 <th>Size</th>
549 <th>MD5 Checksum</th>
550 </tr>
551 <tr>
552 <td>ADT {@adtZipVersion}</td>
553 <td>
554 <a href="http://dl.google.com/android/{@adtZipDownload}">{@adtZipDownload}</a>
555 </td>
556 <td>{@adtZipBytes} bytes</td>
557 <td>{@adtZipChecksum}</td>
558 </tr>
559</table>
560</li>
561
562</li>
Scott Main081127b2010-10-29 15:56:27 -0700563 <li>Follow steps 1 and 2 in the <a href="#installing">default install
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700564 instructions</a> (above).</li>
565 <li>In the Add Site dialog, click <strong>Archive</strong>.</li>
566 <li>Browse and select the downloaded zip file.</li>
Scott Main77847a32010-11-09 16:41:32 -0800567 <li>Enter a name for the local update site (e.g.,
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700568 "Android Plugin") in the "Name" field.</li>
569 <li>Click <strong>OK</strong>.
Scott Main081127b2010-10-29 15:56:27 -0700570 <li>Follow the remaining procedures as listed for
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700571 <a href="#installing">default installation</a> above,
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700572 starting from step 4.</li>
573</ol>
574
575<p>To update your plugin once you've installed using the zip file, you will have
576to follow these steps again instead of the default update instructions.</p>
577
578<h4>Other install errors</h4>
579
Scott Main081127b2010-10-29 15:56:27 -0700580<p>Note that there are features of ADT that require some optional
581Eclipse components (for example, WST). If you encounter an error when
582installing ADT, your Eclipse installion might not include these components.
583For information about how to quickly add the necessary components to your
584Eclipse installation, see the troubleshooting topic
585<a href="{@docRoot}resources/faq/troubleshooting.html#installeclipsecomponents">ADT
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700586Installation Error: "requires plug-in org.eclipse.wst.sse.ui"</a>.</p>
587
588<h4>For Linux users</h4>
Scott Main081127b2010-10-29 15:56:27 -0700589<p>If you encounter this error when installing the ADT Plugin for Eclipse:
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700590<pre>
591An error occurred during provisioning.
592Cannot connect to keystore.
593JKS</pre>
594<p>
595...then your development machine lacks a suitable Java VM. Installing Sun
596Java 6 will resolve this issue and you can then reinstall the ADT
597Plugin.</p>
598
599
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700600<h2 id="updating">Updating the ADT Plugin</h2>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700601
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700602<p>From time to time, a new revision of the ADT Plugin becomes available, with
603new features and bug fixes. Generally, when a new revision of ADT is available,
604you should update to it as soon as convenient. </p>
605
606<p>In some cases, a new revision of ADT will have a dependency on a specific
607revision of the Android SDK Tools. If such dependencies exist, you will need to
608update the SDK Tools component of the SDK after installing the new revision of
609ADT. To update the SDK Tools component, use the Android SDK and AVD Manager, as
610described in <a href="adding-components.html">Adding SDK Components</a>.</p>
611
612<p>To learn about new features of each ADT revision and also any dependencies on
613the SDK Tools, see the listings in the <a href="#notes">Revisions</a>
Scott Main081127b2010-10-29 15:56:27 -0700614section. To determine the version currently installed, open the
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700615Eclipse Installed Software window using <strong>Help</strong>
Scott Main081127b2010-10-29 15:56:27 -0700616&gt; <strong>Software Updates</strong> and refer to the version listed for
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700617"Android Development Tools".</p>
618
Scott Main081127b2010-10-29 15:56:27 -0700619<p>Follow the steps below to check whether an update is available and, if so,
Dirk Dougherty7b229ef2010-03-26 17:32:26 -0700620to install it. </p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700621
622<table style="font-size:100%">
Scott Main77847a32010-11-09 16:41:32 -0800623<tr><th>Eclipse 3.5 (Galileo) and 3.6 (Helios)</th><th>Eclipse 3.4 (Ganymede)</th></tr>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700624<tr>
Scott Main77847a32010-11-09 16:41:32 -0800625<td>
626<!-- 3.5+ steps -->
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700627<ol>
Scott Main77847a32010-11-09 16:41:32 -0800628 <li>Select <strong>Help</strong> &gt; <strong>Check for Updates</strong>.
629 <p>If there are no updates available, a dialog will say so and you're done.</p></li>
630 <li>If there are updates available, select Android DDMS, Android Development Tools,
631 and Android Hierarchy Viewer, then click <strong>Next</strong>.</li>
632 <li>In the Update Details dialog, click <strong>Next</strong>.</li>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700633 <li>Read and accept the license agreement and then click <strong>Finish</strong>.
Scott Main081127b2010-10-29 15:56:27 -0700634 This will download and install the latest version of Android DDMS and
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700635 Android Development Tools.</li>
636 <li>Restart Eclipse.</li>
637</ol>
638</td>
Scott Main77847a32010-11-09 16:41:32 -0800639
640<td width="50%">
641<!-- 3.4 steps -->
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700642<ol>
Scott Main77847a32010-11-09 16:41:32 -0800643 <li>Select <strong>Help</strong> &gt; <strong>Software Updates</strong>.</li>
644 <li>Select the <strong>Available Software</strong> tab.</li>
645 <li>If there are updates available, select Android DDMS, Android Development Tools,
646 and Android Hierarchy Viewer, then click <strong>Update</strong>.</li>
647 <li>In the resulting Available Updates dialog, ensure that each of the listed tools
648 are selected, then click <strong>Next</strong>.</li>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700649 <li>Read and accept the license agreement and then click <strong>Finish</strong>.
Scott Main081127b2010-10-29 15:56:27 -0700650 This will download and install the latest version of Android DDMS and
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700651 Android Development Tools.</li>
652 <li>Restart Eclipse.</li>
653</ol>
654</td>
655</tr>
656</table>
657
658
Scott Main081127b2010-10-29 15:56:27 -0700659<p>If you encounter problems during the update of ADT, you
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700660can try removing the existing ADT plugin and then performing a fresh
Dirk Dougherty22558d02009-12-10 16:25:06 -0800661installation. To remove the plugin, follow the instructions in <a
Scott Main081127b2010-10-29 15:56:27 -0700662href="#uninstalling">Uninstalling the ADT Plugin</a>, below. To reinstall
Dirk Dougherty22558d02009-12-10 16:25:06 -0800663the plugin, follow the instructions in <a
664href="#installing">Installing the ADT Plugin</a>, above.</p>
Dirk Doughertyee58d1b2009-10-16 15:25:15 -0700665