Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 1 | page.title=ADT Plugin for Eclipse |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 2 | sdk.preview=0 |
Dirk Dougherty | 9a97aaf | 2010-09-23 11:48:54 -0700 | [diff] [blame] | 3 | adt.zip.version=0.9.9 |
| 4 | adt.zip.download=ADT-0.9.9.zip |
| 5 | adt.zip.bytes=8301681 |
| 6 | adt.zip.checksum=7deff0c9b25940a74cea7a0815a3bc36 |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 7 | |
| 8 | @jd:body |
| 9 | |
| 10 | <div id="qv-wrapper"> |
| 11 | <div id="qv"> |
| 12 | |
| 13 | <h2>In this document</h2> |
| 14 | <ol> |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 15 | <li><a href="#notes">Revisions</a></li> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 16 | <li><a href="#installing">Installing the ADT Plugin</a> |
| 17 | <ol> |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 18 | <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 Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 21 | <li><a href="#troubleshooting">Troubleshooting</a></li> |
| 22 | </ol> |
| 23 | </li> |
| 24 | <li><a href="#updating">Updating the ADT Plugin</a></li> |
| 25 | <li><a href="#uninstalling">Uninstalling the ADT Plugin</a></li> |
| 26 | </ol> |
| 27 | |
| 28 | </div> |
| 29 | </div> |
| 30 | |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 31 | <p>Android Development Tools (ADT) is a plugin for the Eclipse IDE |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 32 | that is designed to give you a powerful, integrated environment in which |
| 33 | to build Android applications. </p> |
Dirk Dougherty | bf15ce6 | 2009-10-23 19:17:12 -0700 | [diff] [blame] | 34 | |
Scott Main | 13244e5 | 2010-01-19 11:12:07 -0800 | [diff] [blame] | 35 | <p>ADT extends the capabilities of Eclipse to let you quickly set up new Android |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 36 | projects, create an application UI, add components based on the Android |
Dirk Dougherty | bf15ce6 | 2009-10-23 19:17:12 -0700 | [diff] [blame] | 37 | Framework API, debug your applications using the Android SDK tools, and even |
| 38 | export signed (or unsigned) APKs in order to distribute your application.</p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 39 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 40 | <p>Developing in Eclipse with ADT is highly recommended and is the fastest way |
| 41 | to get started. With the guided project setup it provides, as well as tools |
| 42 | integration, custom XML editors, and debug ouput pane, ADT gives you an |
| 43 | incredible boost in developing Android applications. </p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 44 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 45 | <p>This document provides step-by-step instructions on how to download the ADT |
| 46 | plugin and install it into your Eclipse development environment. Note that |
| 47 | before you can install or use ADT, you must have compatible versions of both the |
| 48 | Eclipse IDE and the Android SDK installed. For details, make sure to read <a |
| 49 | href="#installing">Installing the ADT Plugin</a>, below. </p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 50 | |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 51 | <p>If you are already using ADT, this document also provides instructions on |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 52 | how to update ADT to the latest version or how to uninstall it, if necessary. |
| 53 | </p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 54 | |
Scott Main | 1c9bada | 2010-07-07 16:47:16 -0700 | [diff] [blame] | 55 | <p class="caution"><strong>Caution:</strong> There are known issues with the ADT plugin running with |
| 56 | Eclipse 3.6. Please stay on 3.5 until further notice.</p> |
| 57 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 58 | <h2 id="notes">Revisions</h2> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 59 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 60 | <p>The sections below provide notes about successive releases of |
| 61 | the ADT Plugin, as denoted by revision number. </p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 62 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 63 | <script type="text/javascript"> |
| 64 | function toggleDiv(link) { |
| 65 | var toggleable = $(link).parent(); |
| 66 | if (toggleable.hasClass("closed")) { |
| 67 | //$(".toggleme", toggleable).slideDown("fast"); |
| 68 | toggleable.removeClass("closed"); |
| 69 | toggleable.addClass("open"); |
| 70 | $(".toggle-img", toggleable).attr("title", "hide").attr("src", (toRoot + "assets/images/triangle-opened.png")); |
| 71 | } else { |
| 72 | //$(".toggleme", toggleable).slideUp("fast"); |
| 73 | toggleable.removeClass("open"); |
| 74 | toggleable.addClass("closed"); |
| 75 | $(".toggle-img", toggleable).attr("title", "show").attr("src", (toRoot + "assets/images/triangle-closed.png")); |
| 76 | } |
| 77 | return false; |
| 78 | } |
| 79 | </script> |
| 80 | <style> |
| 81 | .toggleable { |
| 82 | padding: .25em 1em; |
| 83 | } |
| 84 | .toggleme { |
| 85 | padding: 1em 1em 0 2em; |
| 86 | line-height:1em; |
| 87 | } |
| 88 | .toggleable a { |
| 89 | text-decoration:none; |
| 90 | } |
Dirk Dougherty | 0d1b081 | 2010-04-07 17:05:16 -0700 | [diff] [blame] | 91 | .toggleme a { |
| 92 | text-decoration:underline; |
| 93 | } |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 94 | .toggleable.closed .toggleme { |
| 95 | display:none; |
| 96 | } |
| 97 | #jd-content .toggle-img { |
| 98 | margin:0; |
| 99 | } |
| 100 | </style> |
| 101 | |
Dirk Dougherty | 022171b | 2010-07-30 19:24:17 -0700 | [diff] [blame] | 102 | |
Dirk Dougherty | 0d1b081 | 2010-04-07 17:05:16 -0700 | [diff] [blame] | 103 | <div class="toggleable opened"> |
| 104 | <a href="#" onclick="return toggleDiv(this)"> |
Dirk Dougherty | 022171b | 2010-07-30 19:24:17 -0700 | [diff] [blame] | 105 | <img src="{@docRoot}assets/images/triangle-opened.png" class="toggle-img" height="9px" width="9px" /> |
Dirk Dougherty | 9a97aaf | 2010-09-23 11:48:54 -0700 | [diff] [blame] | 106 | ADT 0.9.9</a> <em>(September 2010)</em> |
| 107 | <div class="toggleme"> |
| 108 | |
| 109 | |
| 110 | </ul> |
| 111 | </dd> |
| 112 | |
| 113 | <dl> |
| 114 | |
| 115 | <dt>Dependencies:</dt> |
| 116 | |
| 117 | <dd><p>ADT 0.9.9 replaces ADT 0.9.8 and is designed for use with SDK Tools r7 |
| 118 | and later. ADT 0.9.9 includes the ADT 0.9.8 features as well as an important |
| 119 | bugfix, so we recommend that you upgrade as soon as possible. If you haven't |
| 120 | already installed SDK Tools r7 into your SDK, use the Android SDK Manager to do |
| 121 | so.</p></dd> |
| 122 | |
| 123 | <dt>General notes:</dt> |
| 124 | <dd> |
| 125 | <ul> |
| 126 | <li>Fixes a problem in project import, in which source files were deleted in some cases.</li> |
| 127 | <li>Includes all other ADT 0.9.8 features (see below).</li> |
| 128 | </ul> |
| 129 | </dd> |
| 130 | </dl> |
| 131 | </div> |
| 132 | </div> |
| 133 | |
| 134 | <div class="toggleable closed"> |
| 135 | <a href="#" onclick="return toggleDiv(this)"> |
| 136 | <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" /> |
Dirk Dougherty | 74a74d3 | 2010-09-09 18:40:13 -0700 | [diff] [blame] | 137 | ADT 0.9.8</a> <em>(September 2010)</em> |
Dirk Dougherty | 022171b | 2010-07-30 19:24:17 -0700 | [diff] [blame] | 138 | <div class="toggleme"> |
| 139 | |
| 140 | |
| 141 | </ul> |
| 142 | </dd> |
| 143 | |
| 144 | <dl> |
| 145 | |
| 146 | <dt>Dependencies:</dt> |
| 147 | |
Dirk Dougherty | 9a97aaf | 2010-09-23 11:48:54 -0700 | [diff] [blame] | 148 | <dd><p>ADT 0.9.8 is now deprecated. Please use ADT 0.9.9 instead.</p></dd> |
Dirk Dougherty | 022171b | 2010-07-30 19:24:17 -0700 | [diff] [blame] | 149 | |
| 150 | <dt>General notes:</dt> |
| 151 | <dd> |
| 152 | <ul> |
| 153 | <li>Adds a new Action, "Rename Application Package", to the Android Tools |
| 154 | contextual menu. The Action does a full application package refactoring. |
| 155 | <li>Adds support for library projects that don't have a source folder |
| 156 | called <code>src/</code>. There is now support for any number of source folders, |
| 157 | with no name restriction. They can even be in subfolder such as |
| 158 | <code>src/java</code>. If you are already working with library projects created |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 159 | in ADT 0.9.7, see <a |
Dirk Dougherty | 022171b | 2010-07-30 19:24:17 -0700 | [diff] [blame] | 160 | href="{@docRoot}guide/developing/eclipse-adt.html#libraryMigrating">Migrating |
| 161 | library projects to ADT 0.9.8</a> for important information about moving |
| 162 | to the new ADT environment.</li> |
| 163 | <li>Adds support for library projects that depend on other library |
| 164 | projects.</li> |
| 165 | <li>Adds support for additional resource qualifiers: |
| 166 | <code>car</code>/<code>desk</code>, <code>night</code>/<code>notnight</code> and |
| 167 | <code>navexposed</code>/<code>navhidden</code>.</li> |
| 168 | <li>Adds more device screen types in the layout editor. All screen |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 169 | resolution/density combinations listed in the <a |
Dirk Dougherty | 022171b | 2010-07-30 19:24:17 -0700 | [diff] [blame] | 170 | href="{@docRoot}guide/practices/screens_support.html#range">Supporting |
| 171 | Multiple Screens</a> are now available.</li> |
| 172 | <li>Fixes problems with handling of library project names that |
| 173 | contain characters that are incompatible with the Eclipse path variable. |
| 174 | Now properly sets up the link between the main project and the library |
| 175 | project.</li> |
| 176 | </ul> |
| 177 | </dd> |
| 178 | </dl> |
| 179 | </div> |
| 180 | </div> |
| 181 | |
| 182 | |
| 183 | <div class="toggleable closed"> |
| 184 | <a href="#" onclick="return toggleDiv(this)"> |
Dirk Dougherty | 0d1b081 | 2010-04-07 17:05:16 -0700 | [diff] [blame] | 185 | <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" /> |
Dirk Dougherty | c7c7afd | 2010-05-24 09:07:14 -0700 | [diff] [blame] | 186 | ADT 0.9.7</a> <em>(May 2010)</em> |
Dirk Dougherty | 0d1b081 | 2010-04-07 17:05:16 -0700 | [diff] [blame] | 187 | <div class="toggleme"> |
| 188 | |
| 189 | <dl> |
| 190 | <dt>Library projects:</dt> |
| 191 | <dd> |
| 192 | <p>The ADT Plugin now supports the use of <em>library projects</em> during |
| 193 | development, a capability that lets you store shared Android application |
| 194 | code and resources in a separate development project. You can then reference the |
| 195 | library project from other Android projects and, at build time, the tools |
| 196 | compile the shared code and resources as part of the dependent applications. |
| 197 | More information about this feature is available in the <a |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 198 | href="{@docRoot}guide/developing/eclipse-adt.html#libraryProject">Developing |
Dirk Dougherty | 0d1b081 | 2010-04-07 17:05:16 -0700 | [diff] [blame] | 199 | in Eclipse with ADT</a> document. </p> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 200 | <p>If you are not developing in Eclipse, <a |
| 201 | href="tools-notes.html">SDK Tools r6</a> provides the equivalent library |
Dirk Dougherty | 0d1b081 | 2010-04-07 17:05:16 -0700 | [diff] [blame] | 202 | project support through the Ant build system.</p> |
| 203 | </dd> |
| 204 | </dl> |
| 205 | </div> |
| 206 | </div> |
| 207 | |
Dirk Dougherty | 022171b | 2010-07-30 19:24:17 -0700 | [diff] [blame] | 208 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 209 | <div class="toggleable closed"> |
| 210 | <a href="#" onclick="return toggleDiv(this)"> |
| 211 | <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" /> |
| 212 | ADT 0.9.6</a> <em>(March 2010)</em> |
| 213 | <div class="toggleme"> |
| 214 | |
| 215 | <dl> |
| 216 | <dt>Dependencies:</dt> |
| 217 | |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 218 | <dd><p>ADT 0.9.6 is designed for use with SDK Tools r5 and later. Before |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 219 | updating to ADT 0.9.6, we highly recommend that you use the Android SDK and |
| 220 | AVD Manager to install SDK Tools r5 into your SDK.</p></dd> |
| 221 | |
| 222 | <dt>General Notes:</dt> |
| 223 | <dd> |
| 224 | <ul> |
| 225 | <li>Editing <code>default.properties</code> outside of Eclipse will now |
| 226 | automatically update the project.</li> |
| 227 | <li>Loads the SDK content only when a project requires it. This will make |
| 228 | Eclipse use less resources when the SDK contains many versions of Android.</li> |
| 229 | <li>Resolves potential deadlock between modal dialogs, when launching ADT the |
| 230 | first time with the SDK Usage panel.</li> |
| 231 | <li>Fixes issues with the New Project Wizard when selecting samples.</li> |
| 232 | </ul> |
| 233 | </dd> |
| 234 | <dt>AVD/SDK Manager:</dt> |
| 235 | <dd> |
| 236 | <ul> |
| 237 | <li>Adds support for platform samples components.</li> |
| 238 | <li>Improves support for dependency between components.</li> |
| 239 | <li>AVDs now sorted by API level.</li> |
| 240 | <li>The AVD creation dialog now enforces a minimum SD card size of 9MB.</li> |
| 241 | <li>Prevents deletion of running AVDs.</li> |
| 242 | </ul> |
| 243 | </dd> |
| 244 | <dt>DDMS:</dt> |
| 245 | <dd> |
| 246 | <ul> |
| 247 | <li>DDMS plug-in now contains the Allocation Tracker view.</li> |
| 248 | <li>New action in the Logcat view: "Go to problem" lets you go directly from an |
| 249 | exception trace output to the code.</li> |
| 250 | </ul> |
| 251 | </dd> |
| 252 | <dt>Editors:</dt> |
| 253 | <dd> |
| 254 | <ul> |
| 255 | <li>Explode mode in the Visual Layout Editor adds a margin to all layout objects |
| 256 | so that it's easier to see embedded or empty layouts.</li> |
| 257 | <li>Outline mode in the Visual Layout Editor draws layout outline to make it |
| 258 | easier to see layout objects.</li> |
| 259 | <li>Several fixes in the configuration selector of the Visual Layout |
| 260 | Editor.</li> |
| 261 | </ul> |
| 262 | </dd> |
| 263 | <dt>Application launching:</dt> |
| 264 | <dd> |
| 265 | <ul> |
| 266 | <li>Applications launched from ADT now behave as if they were clicked from the |
| 267 | Home screen.</li> |
| 268 | <li>Fixes issue where add-on with no optional library would not show up as valid |
| 269 | targets for application launches.</li> |
| 270 | <li>Resolves possible crash when launching applications.</li> |
| 271 | </ul> |
| 272 | </dd> |
| 273 | </dl> |
| 274 | </div> |
| 275 | </div> |
| 276 | |
| 277 | <div class="toggleable closed"> |
| 278 | <a href="#" onclick="return toggleDiv(this)"> |
| 279 | <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" /> |
| 280 | ADT 0.9.5</a> <em>(December 2009)</em> |
| 281 | <div class="toggleme"> |
| 282 | <dl> |
| 283 | <dt>Dependencies:</dt> |
| 284 | |
| 285 | <dd><p>ADT 0.9.5 requires features provided in SDK Tools r4 or higher. If you install |
| 286 | ADT 0.9.5, which is highly recommended, you should use the Android SDK and AVD |
| 287 | Manager to download thye latest SDK Tools into your SDK. For more information, |
| 288 | see <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</p> |
| 289 | </dd> |
| 290 | |
| 291 | <dt>General Notes:</dt> |
| 292 | <dd> |
| 293 | <ul> |
| 294 | <li>AVD Launch dialog now shows scale value.</li> |
| 295 | <li>Fixes potential NPE in SDK Manager on AVD launch, for older AVD with no skin name specified.</li> |
| 296 | <li>Fixes XML validation issue in on older Java versions.</li> |
| 297 | <li>.apk packaging now properly ignores vi swap files as well as hidden files.</li> |
| 298 | </ul> |
| 299 | </dd> |
| 300 | </dl> |
| 301 | </div> |
| 302 | </div> |
| 303 | |
| 304 | <div class="toggleable closed"> |
| 305 | <a href="#" onclick="return toggleDiv(this)"> |
| 306 | <img src="{@docRoot}assets/images/triangle-closed.png" class="toggle-img" height="9px" width="9px" /> |
| 307 | ADT 0.9.4</a> <em>(October 2009)</em> |
| 308 | <div class="toggleme"> |
| 309 | <dl> |
| 310 | <dt>Dependencies:</dt> |
| 311 | |
| 312 | <dd><p>ADT 0.9.4 requires features provided in SDK Tools r3 or higher. If you install |
| 313 | ADT 0.9.4, which is highly recommended, you should use the Android SDK and AVD |
| 314 | Manager to download the latest SDK Tools into your SDK. For more information, |
| 315 | see <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</p> |
| 316 | </dd> |
| 317 | |
| 318 | <dt>Project Creation Wizard:</dt> |
| 319 | <dd> |
| 320 | <ul> |
| 321 | <li>New option to create a project from a sample by choosing it from a list.</li> |
| 322 | </ul> |
| 323 | </dd> |
| 324 | |
| 325 | <dt>Layout Editor:</dt> |
| 326 | <dd> |
| 327 | <ul> |
| 328 | <li>Improved Configuration selector that lets you see how your layout will |
| 329 | render on different devices. Default device descriptions include ADP1 |
| 330 | and Google Ion, while SDK add-ons can also provide new descriptions. |
| 331 | A new UI allows you to create custom descriptions.</li> |
| 332 | <li>Adds a new clipping toggle, to let you see your full layout even if it's |
| 333 | bigger than the screen.</li> |
| 334 | </ul> |
| 335 | </dd> |
| 336 | |
| 337 | <dt>DDMS Integration:</dt> |
| 338 | <dd> |
| 339 | <ul> |
| 340 | <li>Includes the improvements from the standlone DDMS, revision 3.</li> |
| 341 | <li>Adds an option to open HPROF files into eclipse instead of writing them on |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 342 | disk. If a profiler such as MAT (<a href="http://eclipse.org/mat">Memory Analyzer |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 343 | Tool</a>) is installed, it'll open the file.</li> |
| 344 | </ul> |
| 345 | </dd> |
| 346 | |
| 347 | <dt>Android SDK and AVD Manager integration:</dt> |
| 348 | <dd> |
| 349 | <ul> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 350 | <li>Includes the improvements from the standalone Android SDK and AVD Manager, |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 351 | revision 3.</li> |
| 352 | </ul> |
| 353 | </dd> |
| 354 | </dl> |
| 355 | </div> |
| 356 | </div> |
| 357 | |
| 358 | <h2 id="installing">Installing the ADT Plugin</h2> |
| 359 | |
| 360 | <p>The sections below provide instructions on how to download and install |
| 361 | ADT into your Eclipse environment. If you encounter problems, see the <a |
| 362 | href="#troubleshooting">Troubleshooting</a> section.</p> |
| 363 | |
| 364 | <h3 id="preparing">Preparing Your Development Computer</h3> |
| 365 | |
| 366 | <p>ADT is a plugin for the Eclipse IDE. Before you can install or use ADT, |
| 367 | you must have a compatible version of Eclipse installed on your development |
| 368 | computer. </p> |
| 369 | |
| 370 | <ul> |
| 371 | <li>If Eclipse is already installed on your computer, make sure that it is |
| 372 | a version that is compatible with ADT and the Android SDK. Check the <a |
| 373 | href="requirements.html">System Requirements</a> document for |
| 374 | a list of Eclipse versions that are compatible with the Android SDK.</li> |
| 375 | <li>If you need to install or update Eclipse, you can download it from this |
| 376 | location: |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 377 | |
Dirk Dougherty | 22558d0 | 2009-12-10 16:25:06 -0800 | [diff] [blame] | 378 | <p style="margin-left:2em;"><a href= |
| 379 | "http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a> |
| 380 | </p> |
| 381 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 382 | <p>A Java or RCP version of Eclipse is recommended.</p></li> |
| 383 | </ul> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 384 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 385 | <p>Additionally, before you can configure or use ADT, you must install the |
| 386 | Android SDK starter package, as described in <a |
Robert Ly | ef13d02 | 2010-07-12 14:32:22 -0700 | [diff] [blame] | 387 | href="installing.html#Installing">Downloading the SDK Starter Package</a>. |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 388 | Specifically, you need to install a compatible version of the Android SDK Tools |
| 389 | and at least one development platform. To simplify ADT setup, we recommend |
| 390 | installing the Android SDK prior to installing ADT. </p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 391 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 392 | <p>When your Eclipse and Android SDK environments are ready, continue with the |
| 393 | ADT installation as described in the steps below. </p> |
| 394 | |
| 395 | <h3 id="downloading">Downloading the ADT Plugin</h3> |
| 396 | |
| 397 | <p>Use Update Manager feature of your Eclipse installation to install the latest |
| 398 | revision of ADT on your development computer.<p> |
| 399 | |
| 400 | <p>Assuming that you have a compatible version of the Eclipse IDE installed, as |
| 401 | described in <a href="#preparing">Preparing for Installation</a>, above, follow |
| 402 | these steps to download the ADT plugin and install it in your Eclipse |
| 403 | environment. </p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 404 | |
| 405 | <table style="font-size:100%"> |
| 406 | <tr><th>Eclipse 3.4 (Ganymede)</th><th>Eclipse 3.5 (Galileo)</th></tr> |
| 407 | <tr> |
| 408 | <td width="45%"> |
| 409 | <!-- 3.4 steps --> |
| 410 | <ol> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 411 | <li>Start Eclipse, then select <strong>Help</strong> > <strong>Software Updates...</strong>. |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 412 | In the dialog that appears, click the <strong>Available Software</strong> tab. </li> |
| 413 | <li>Click <strong>Add Site...</strong> </li> |
| 414 | <li>In the Add Site dialog that appears, enter this URL in the "Location" field: |
| 415 | <pre style="margin-left:0">https://dl-ssl.google.com/android/eclipse/</pre> |
Scott Main | 13244e5 | 2010-01-19 11:12:07 -0800 | [diff] [blame] | 416 | <p>Note: If you have trouble acquiring the plugin, try using "http" in the Location URL, |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 417 | instead of "https" (https is preferred for security reasons).</p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 418 | <p>Click <strong>OK</strong>.</p></li> |
| 419 | <li>Back in the Available Software view, you should see the plugin listed by the URL, |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 420 | with "Developer Tools" nested within it. Select the checkbox next to |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 421 | Developer Tools and click <strong>Install...</strong></li> |
| 422 | <li>On the subsequent Install window, "Android DDMS" and "Android Development Tools" |
| 423 | should both be checked. Click <strong>Next</strong>. </li> |
| 424 | <li>Read and accept the license agreement, then click <strong>Finish</strong>.</li> |
| 425 | <li>Restart Eclipse. </li> |
| 426 | </ol> |
| 427 | |
| 428 | </td> |
| 429 | <td> |
| 430 | <!-- 3.5 steps --> |
| 431 | <ol> |
| 432 | <li>Start Eclipse, then select <strong>Help</strong> > <strong>Install |
Scott Main | 13244e5 | 2010-01-19 11:12:07 -0800 | [diff] [blame] | 433 | New Software</strong>. </li> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 434 | <li>In the Available Software dialog, click <strong>Add...</strong>.</li> |
| 435 | <li>In the Add Site dialog that appears, enter a name for the remote site |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 436 | (for example, "Android Plugin") in the "Name" field. |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 437 | <p>In the "Location" field, enter this URL:</p> |
| 438 | <pre>https://dl-ssl.google.com/android/eclipse/</pre> |
Scott Main | 13244e5 | 2010-01-19 11:12:07 -0800 | [diff] [blame] | 439 | <p>Note: If you have trouble acquiring the plugin, you can try |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 440 | using "http" in the URL, instead of "https" (https is preferred for |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 441 | security reasons).</p> |
| 442 | <p>Click <strong>OK</strong>.</p> |
| 443 | </li> |
| 444 | <li>Back in the Available Software view, you should now see "Developer |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 445 | Tools" added to the list. Select the checkbox next to Developer Tools, |
| 446 | which will automatically select the nested tools Android DDMS and Android |
| 447 | Development Tools. |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 448 | Click <strong>Next</strong>. </li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 449 | <li>In the resulting Install Details dialog, the Android DDMS and Android |
| 450 | Development Tools features are listed. Click <strong>Next</strong> to |
| 451 | read and accept the license agreement and install any dependencies, |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 452 | then click <strong>Finish</strong>. </li> |
| 453 | <li>Restart Eclipse. </li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 454 | |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 455 | </ol> |
| 456 | </td> |
| 457 | </tr> |
| 458 | </table> |
| 459 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 460 | <h3 id="preparing">Configuring the ADT Plugin</h3> |
| 461 | |
Dirk Dougherty | 4b4af99 | 2010-09-13 11:24:06 -0700 | [diff] [blame] | 462 | <p>Once you've successfully downloaded ADT as described above, the next step |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 463 | is to modify your ADT preferences in Eclipse to point to the Android SDK directory:</p> |
| 464 | |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 465 | <ol> |
| 466 | <li>Select <strong>Window</strong> > <strong>Preferences...</strong> to open the Preferences |
| 467 | panel (Mac OS X: <strong>Eclipse</strong> > <strong>Preferences</strong>).</li> |
| 468 | <li>Select <strong>Android</strong> from the left panel. </li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 469 | <li>For the <em>SDK Location</em> in the main panel, click <strong>Browse...</strong> and |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 470 | locate your downloaded SDK directory. </li> |
| 471 | <li>Click <strong>Apply</strong>, then <strong>OK</strong>.</li> |
| 472 | </ol> |
| 473 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 474 | <p>Done! If you haven't encountered any problems, then the installation is |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 475 | complete. If you're installing the Android SDK for the first time, return to <a |
| 476 | href="{@docRoot}sdk/installing.html#InstallingADT">Installing the SDK</a> to complete your setup. |
| 477 | </p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 478 | |
| 479 | |
| 480 | <h3 id="troubleshooting">Troubleshooting ADT Installation</h3> |
| 481 | |
| 482 | <p> If you are having trouble downloading the ADT plugin after following the |
| 483 | steps above, here are some suggestions: </p> |
| 484 | |
| 485 | <ul> |
| 486 | <li>If Eclipse can not find the remote update site containing the ADT plugin, |
| 487 | try changing the remote site URL to use http, rather than https. That is, set |
| 488 | the Location for the remote site to: |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 489 | <pre>http://dl-ssl.google.com/android/eclipse/</pre></li> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 490 | <li>If you are behind a firewall (such as a corporate firewall), make sure that |
| 491 | you have properly configured your proxy settings in Eclipse. In Eclipse 3.3/3.4, |
| 492 | you can configure proxy information from the main Eclipse menu in |
| 493 | <strong>Window</strong> (on Mac OS X, <strong>Eclipse</strong>) > |
| 494 | <strong>Preferences</strong> > <strong>General</strong> > <strong>Network |
| 495 | Connections</strong>.</li> |
| 496 | </ul> |
| 497 | |
| 498 | <p> If you are still unable to use Eclipse to download the ADT plugin as a |
| 499 | remote update site, you can download the ADT zip file to your local machine and |
| 500 | manually install it:</p> |
| 501 | |
| 502 | <ol> |
| 503 | <li>Download the current ADT Plugin zip file from the table below (do not unpack it). |
| 504 | |
| 505 | <table class="download"> |
| 506 | <tr> |
| 507 | <th>Name</th> |
| 508 | <th>Package</th> |
| 509 | <th>Size</th> |
| 510 | <th>MD5 Checksum</th> |
| 511 | </tr> |
| 512 | <tr> |
| 513 | <td>ADT {@adtZipVersion}</td> |
| 514 | <td> |
| 515 | <a href="http://dl.google.com/android/{@adtZipDownload}">{@adtZipDownload}</a> |
| 516 | </td> |
| 517 | <td>{@adtZipBytes} bytes</td> |
| 518 | <td>{@adtZipChecksum}</td> |
| 519 | </tr> |
| 520 | </table> |
| 521 | </li> |
| 522 | |
| 523 | </li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 524 | <li>Follow steps 1 and 2 in the <a href="#installing">default install |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 525 | instructions</a> (above).</li> |
| 526 | <li>In the Add Site dialog, click <strong>Archive</strong>.</li> |
| 527 | <li>Browse and select the downloaded zip file.</li> |
| 528 | <li>In Eclipse 3.5 only, enter a name for the local update site (e.g., |
| 529 | "Android Plugin") in the "Name" field.</li> |
| 530 | <li>Click <strong>OK</strong>. |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 531 | <li>Follow the remaining procedures as listed for |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 532 | <a href="#installing">default installation</a> above, |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 533 | starting from step 4.</li> |
| 534 | </ol> |
| 535 | |
| 536 | <p>To update your plugin once you've installed using the zip file, you will have |
| 537 | to follow these steps again instead of the default update instructions.</p> |
| 538 | |
| 539 | <h4>Other install errors</h4> |
| 540 | |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 541 | <p>Note that there are features of ADT that require some optional |
| 542 | Eclipse components (for example, WST). If you encounter an error when |
| 543 | installing ADT, your Eclipse installion might not include these components. |
| 544 | For information about how to quickly add the necessary components to your |
| 545 | Eclipse installation, see the troubleshooting topic |
| 546 | <a href="{@docRoot}resources/faq/troubleshooting.html#installeclipsecomponents">ADT |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 547 | Installation Error: "requires plug-in org.eclipse.wst.sse.ui"</a>.</p> |
| 548 | |
| 549 | <h4>For Linux users</h4> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 550 | <p>If you encounter this error when installing the ADT Plugin for Eclipse: |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 551 | <pre> |
| 552 | An error occurred during provisioning. |
| 553 | Cannot connect to keystore. |
| 554 | JKS</pre> |
| 555 | <p> |
| 556 | ...then your development machine lacks a suitable Java VM. Installing Sun |
| 557 | Java 6 will resolve this issue and you can then reinstall the ADT |
| 558 | Plugin.</p> |
| 559 | |
| 560 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 561 | <h2 id="updating">Updating the ADT Plugin</h2> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 562 | |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 563 | <p>From time to time, a new revision of the ADT Plugin becomes available, with |
| 564 | new features and bug fixes. Generally, when a new revision of ADT is available, |
| 565 | you should update to it as soon as convenient. </p> |
| 566 | |
| 567 | <p>In some cases, a new revision of ADT will have a dependency on a specific |
| 568 | revision of the Android SDK Tools. If such dependencies exist, you will need to |
| 569 | update the SDK Tools component of the SDK after installing the new revision of |
| 570 | ADT. To update the SDK Tools component, use the Android SDK and AVD Manager, as |
| 571 | described in <a href="adding-components.html">Adding SDK Components</a>.</p> |
| 572 | |
| 573 | <p>To learn about new features of each ADT revision and also any dependencies on |
| 574 | the SDK Tools, see the listings in the <a href="#notes">Revisions</a> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 575 | section. To determine the version currently installed, open the |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 576 | Eclipse Installed Software window using <strong>Help</strong> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 577 | > <strong>Software Updates</strong> and refer to the version listed for |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 578 | "Android Development Tools".</p> |
| 579 | |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 580 | <p>Follow the steps below to check whether an update is available and, if so, |
Dirk Dougherty | 7b229ef | 2010-03-26 17:32:26 -0700 | [diff] [blame] | 581 | to install it. </p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 582 | |
| 583 | <table style="font-size:100%"> |
| 584 | <tr><th>Eclipse 3.4 (Ganymede)</th><th>Eclipse 3.5 (Galileo)</th></tr> |
| 585 | <tr> |
| 586 | <td width="50%"> |
| 587 | <!-- 3.4 steps --> |
| 588 | <ol> |
| 589 | <li>Select <strong>Help</strong> > <strong>Software Updates</strong>.</li> |
| 590 | <li>Select the <strong>Available Software</strong> tab.</li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 591 | <li>Select the checkboxes next to Android DDMS and Android Developer Tools, |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 592 | then click <strong>Update</strong>.</li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 593 | <li>In the resulting Available Updates dialog, ensure that both Android DDMS |
| 594 | and Android Development Tools are selected, then click |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 595 | <strong>Next</strong>.</li> |
| 596 | <li>Read and accept the license agreement and then click <strong>Finish</strong>. |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 597 | This will download and install the latest version of Android DDMS and |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 598 | Android Development Tools.</li> |
| 599 | <li>Restart Eclipse.</li> |
| 600 | </ol> |
| 601 | </td> |
| 602 | <td> |
| 603 | <!-- 3.5 steps --> |
| 604 | <ol> |
| 605 | <li>Select <strong>Help</strong> > <strong>Check for Updates</strong>. </li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 606 | <li>In the resulting Available Updates dialog, locate the Android DDMS and |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 607 | Android Development Tools features in the list and ensure that the checkboxes |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 608 | next to them are selected. Click <strong>Next</strong>. |
| 609 | <p>If the Available Updates dialog does not list Android DDMS and Android |
| 610 | Development tools, make sure that you have set up a remote update site |
| 611 | for them, as described in |
| 612 | <a href="#installing">Installing the ADT Plugin</a>. |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 613 | </p></li> |
| 614 | <li>In the Update Details dialog, click <strong>Next</strong>.</li> |
| 615 | <li>Read and accept the license agreement and then click <strong>Finish</strong>. |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 616 | This will download and install the latest version of Android DDMS and |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 617 | Android Development Tools.</li> |
| 618 | <li>Restart Eclipse.</li> |
| 619 | </ol> |
| 620 | </td> |
| 621 | </tr> |
| 622 | </table> |
| 623 | |
| 624 | |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 625 | <p>If you encounter problems during the update of ADT, you |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 626 | can try removing the existing ADT plugin and then performing a fresh |
Dirk Dougherty | 22558d0 | 2009-12-10 16:25:06 -0800 | [diff] [blame] | 627 | installation. To remove the plugin, follow the instructions in <a |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 628 | href="#uninstalling">Uninstalling the ADT Plugin</a>, below. To reinstall |
Dirk Dougherty | 22558d0 | 2009-12-10 16:25:06 -0800 | [diff] [blame] | 629 | the plugin, follow the instructions in <a |
| 630 | href="#installing">Installing the ADT Plugin</a>, above.</p> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 631 | |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 632 | |
| 633 | <h2 id="uninstalling">Uninstalling the ADT plugin</h2> |
| 634 | |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 635 | <p><p>If you encounter problems when installing or updating ADT, you |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 636 | can try removing the existing ADT plugin and then performing a fresh |
| 637 | installation. To remove ADT, follow these steps: </p> |
| 638 | |
| 639 | <table style="font-size:100%"> |
| 640 | <tr><th>Eclipse 3.4 (Ganymede)</th><th>Eclipse 3.5 (Galileo)</th></tr> |
| 641 | <tr> |
| 642 | <td width="50%"> |
| 643 | <!-- 3.4 steps --> |
| 644 | <ol> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 645 | <li>Select <strong>Help</strong> > <strong>Software Updates</strong> > |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 646 | <strong>Manage Configuration</strong>. </li> |
| 647 | <li>Expand the list in the left panel to reveal the installed tools.</li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 648 | <li>Right-click "Android Editors" and click <strong>Uninstall</strong>. Click <strong>OK</strong> |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 649 | to confirm.</li> |
Scott Main | 081127b | 2010-10-29 15:56:27 -0700 | [diff] [blame^] | 650 | <li>Restart Eclipse. |
Dirk Dougherty | ee58d1b | 2009-10-16 15:25:15 -0700 | [diff] [blame] | 651 | <p>(Do not uninstall "Android Development Tools".)</p></li> |
| 652 | </ol> |
| 653 | </td> |
| 654 | <td> |
| 655 | <!-- 3.5 steps --> |
| 656 | <ol> |
| 657 | <li>Select <strong>Help</strong> > <strong>Install New Software</strong>.</li> |
| 658 | <li>In the "Details" panel, click the "What is already installed?" link.</li> |
| 659 | <li>In the <strong>Eclipse Installation Details</strong> dialog, select "Android DDMS" and "Android Development Tools" and then click <strong>Uninstall</strong>.</li> |
| 660 | <li>In the next window, confirm that the ADT features are selected for uninstall and then click <strong>Finish</strong> to uninstall.</li> |
| 661 | <li>Restart Eclipse.</li> |
| 662 | </ol> |
| 663 | </td> |
| 664 | </tr> |
| 665 | </table> |
| 666 | |