path: root/docs/html/sdk/1.1_r1/installing.jd

page.title=Installing the Android SDK
sdk.version=1.1_r1

@jd:body


<p>This page describes how to install the Android SDK and set up your
development environment. If you haven't downloaded the SDK, you can
do so from the 
<a href="{@docRoot}sdk/1.1_r1/index.html">Download</a> page.</p>

<p>If you encounter any problems during installation, see the 
<a href="#installnotes">Installation Notes</a> at the bottom of
this page.</p>

<h4 style="margin-top">Upgrading?</h4>
<p>If you have already developed applications using an earlier version
of the SDK, please skip this page and read the 
<a href="{@docRoot}sdk/1.1_r1/upgrading.html"><strong>Upgrading the
SDK</strong></a></b> document instead.
</p>


<h2 id="setup">Preparing for Installation</h2>

<p>Before you get started with the Android SDK, take a moment to confirm
that your development machine meets the <a
href="{@docRoot}sdk/1.1_r1/requirements.html">system requirements</a>.
</p>

<p>If you will be developing on Eclipse with the Android Development
Tools (ADT) Plugin &mdash; the recommended path if you are new to
Android &mdash; make sure that you have a suitable version of Eclipse
installed on your computer. If you need to install Eclipse, you can
download it from this location: </p>

<p style="margin-left:2em;"><a href=
"http://www.eclipse.org/downloads/">http://www.eclipse.org/downloads/</a
></p>

<p>A Java or RCP version of Eclipse is recommended. </p>

<h2 id="installingsdk">Installing the SDK</h2>

	<p>After downloading the SDK, unpack the .zip archive to a suitable location on your machine. By default, the SDK files are unpacked into a directory named  <code>android_sdk_<em>&lt;platform</em>&gt;_<em>&lt;release&gt;</em>_<em>&lt;build&gt;</em></code>. The directory contains a link to a local copy of the documentation and the subdirectories <code>tools/</code>, <code>samples/</code>, and others. </p>
	
	<p>Make a note of the name and location of the unpacked SDK directory on your system &mdash; you will need to refer to the SDK directory later, when setting up the Android plugin or using SDK tools. </p>

        <p>Optionally, you can add the path to the SDK <code>tools</code> directory to your path. As mentioned above, the <code>tools/</code> directory is located in the SDK directory. </p>
     <ul>
          <li>On Linux, edit your ~/.bash_profile or ~/.bashrc file. Look
          for a line that sets the PATH environment variable and add the
          full path to the <code>tools/</code> directory to it. If you don't 
          see a line setting the path, you can add one:</li>

          <ul><code>export PATH=${PATH}:<em>&lt;your_sdk_dir&gt;</em>/tools</code></ul>

          <li>On a Mac, look in your home directory for .bash_profile and
          proceed as for Linux. You can create the .bash_profile, if 
          you haven't already set one up on your machine. </li>

          <li>On Windows, right click on My Computer, and select Properties.  
        Under the Advanced tab, hit the Environment Variables button, and in the
        dialog that comes up, double-click on Path under System Variables. Add  the full path to the <code>tools/</code> directory to the path. </li>
        </ul>

        <p>Adding <code>tools</code> to your path lets you run Android Debug Bridge (adb) and the other command line <a href="{@docRoot}guide/developing/tools/index.html">tools</a> without needing to supply the full path to the tools directory. Note that, if you update your SDK, you should remember to update your PATH settings to point to the new location, if different.</p>


<p>If you will be using the Eclipse IDE as your environment for developing Android applications, continue reading the next
section in order to install the Android Development Tools plugin and set up Eclipse. If you choose not to use Eclipse, you can 
develop Android applications using other tools &mdash; read the guide to developing 
<a href="{@docRoot}guide/developing/other-ide.html">in other IDEs</a>.</p>


<h2 id="installingplugin">Installing the ADT Plugin for Eclipse</h2>

<p>Android offers a custom plugin for the Eclipse IDE, called Android
Development Tools (ADT), that is designed to give you a powerful,
integrated environment in which to build Android applications. It
extends the capabilites of Eclipse to let you quickly set up new Android
projects, create an application UI, add components based on the Android
Framework API, and debug using the Android SDK tools.</p>

<p>If you are new to Android or want to develop using the Eclipse IDE,
the ADT plugin will be an essential part of your development
environment. In general, using Eclipse with ADT is a highly recommended
approach and is the fastest way to get started. This section describes
how to install ADT into your Eclipse environment. 

<p>If you prefer to work in a development environment other than Eclipse,
you do not need to install Eclipse or the ADT Plugin. Instead, you can 
access the SDK tools directly to build and debug your application. </p>

<p>Once you have Eclipse installed, as described in <a href="#setup">
Preparing for Installation</a>, follow the steps below to
download the ADT plugin and install it in your respective Eclipse
environment. </p>

<table style="font-size:100%">
<tr><th>Eclipse 3.3 (Europa)</th><th>Eclipse 3.4 (Ganymede)</th></tr>
<tr>
<td width="45%">
<ol>
    <li>Start Eclipse, then select <strong>Help</strong> &gt; <strong>Software Updates</strong> &gt; <strong>Find
            and Install...</strong>. </li>

    <li>In the dialog that appears, select <strong>Search for new features to install</strong> and click <strong>Next</strong>. </li>
    <li>Click <strong>New Remote Site</strong>. </li>
    <li>In the resulting dialog box, enter a name for the remote site (e.g. Android Plugin) and enter this as its URL:
        <pre>https://dl-ssl.google.com/android/eclipse/</pre>
        <p>Alternatively, you can use http in the Location URL, if you are having 
         trouble with https (https is preferred for security reasons).</p>
        <pre>http://dl-ssl.google.com/android/eclipse/</pre>
        <p>Click <strong>OK</strong>.</p> </li>
    <li>You should now see the new site added to the search list (and checked).
        Click <strong>Finish</strong>. </li>
    <li>In the subsequent Search Results dialog box, select the checkbox for
    <strong>Android Plugin</strong> &gt; <strong>Developer Tools</strong>.
    This will check both features:  "Android Developer Tools", and "Android
    Editors". The Android Editors feature is optional, but recommended.  If
    you choose to install it, you need the WST plugin mentioned earlier in this
    page. Click <strong>Next</strong>. </li>
    <li>Read the license agreement and then select <strong>Accept terms of the license agreement</strong>. 
     Click <strong>Next</strong>. </li>
    <li>Click <strong>Finish</strong>. </li>

    <li>The ADT plugin is not signed; you can accept the installation anyway
        by clicking <strong>Install All</strong>. </li>
    <li>Restart Eclipse. </li>
</ol>

</td>
<td>

<ol>
    <li>Start Eclipse, then select <strong>Help</strong> &gt; <strong>Software Updates...</strong>.
    </li>
    <li>In the dialog that appears, click the <strong>Available Software</strong> tab.
    </li>
    <li>Click <strong>Add Site...</strong>
    </li>
    <li>Enter this as the Location:
      <pre>https://dl-ssl.google.com/android/eclipse/</pre>
      <p>Alternatively, you can use http in the Location URL, if you are having 
         trouble with https (https is preferred for security reasons).</p>
      <pre>http://dl-ssl.google.com/android/eclipse/</pre>
      <p>Click <strong>OK</strong>.</p></li>
    <li>Back in the Available Software view, you should see the plugin. Select the checkbox next to 
      <em>Developer Tools</em>  and click <strong>Install...</strong>
    </li>
    <li>On the subsequent Install window, "Android Developer Tools", and "Android Editors" should both be checked. 
    The Android Editors feature is optional, but recommended.  If
    you choose to install it, you need the WST plugin mentioned earlier in this
    page. Click <strong>Next</strong>.
     </li>
    <li>Accept the license agreement and click <strong>Finish</strong>.</li>
    <li>Restart Eclipse. </li>
</ol>

</td>
</tr>
</table>

<p>Now, you just need to modify your Eclipse preferences to point to the Android SDK directory:</p>
<ol>
    <li>Select <strong>Window</strong> &gt; <strong>Preferences...</strong> to open the Preferences
        panel. (Mac OS X: <strong>Eclipse</strong> &gt; <strong>Preferences</strong>) </li>
    <li>Select <strong>Android</strong> from the left panel. </li>
    <li>For the SDK Location in the main panel, click <strong>Browse...</strong> and locate the SDK directory. </li>
    <li>Click <strong>Apply</strong>, then <strong>OK</strong>.</li>
</ol>

<p>Done! If you haven't encountered any problems, then you're ready to
begin developing Android applications. See the <a href="#next">After 
Installation: Next Steps</a> section for suggestions on how to start. </p>


<h3 id="troubleshooting">Troubleshooting ADT Installation</h3>
<p> 
If you are having trouble downloading the ADT plugin after following the steps above, here are some suggestions: </p>

<ul>
	<li>If Eclipse can not find the remote update site containing the ADT plugin, try changing the remote site URL to use http, rather than https. That is, set the Location for the remote site to:
        <pre>http://dl-ssl.google.com/android/eclipse/</pre></li>
	<li>If you are behind a firewall (such as a corporate firewall), make
        sure that you have properly configured your proxy settings in Eclipse.
        In Eclipse 3.3/3.4, you can configure proxy information from the main
        Eclipse menu in <strong>Window</strong> (on Mac, <strong>Eclipse</strong>) &gt; <strong>Preferences</strong> &gt; <strong>General</strong> &gt; <strong>Network Connections</strong>.</li>
</ul>
<p> 
If you are still unable to use Eclipse to download the ADT plugin as a remote update site, you can download the ADT files to your local machine using a browser and the install the files in Eclipse from there:
</p>
<ol>
<li><a href="{@docRoot}sdk/adt_download.html">Download the ADT zip file</a> (do not unpack it).
<li>Follow steps 1 and 2 in the default install instructions (above).
<li>In Eclipse 3.3, click <strong>New Archive Site...</strong>. <br/>
    In Eclipse 3.4, click <strong>Add Site...</strong>, then <strong>Archive...</strong>
<li>Browse and select the downloaded the zip file.
<li>Follow the remaining procedures, above, starting from steps 5.
</ol>
<p> 
Note that to update your plugin, you will have to follow these steps again instead of the default update instructions.</p>

<p>Note that the "Android Editors" feature of ADT requires several optional 
Eclipse components (for example, WST). If you encounter an error when 
installing ADT, your Eclipse installion might not include those components. 
For information about how to quickly add the necessary components to your 
Eclipse installation, see the troubleshooting topic 
<a href="{@docRoot}guide/appendix/faq/troubleshooting.html#installeclipsecomponents">ADT Installation Error: "requires plug-in org.eclipse.wst.sse.ui"</a>.</p>

<h4>For Linux users</h4>
<p>If you encounter this error when installing the ADT Plugin for Eclipse: 
<pre>
An error occurred during provisioning.
Cannot connect to keystore.
JKS</pre>
<p>
...then your development machine lacks a suitable Java VM. Installing Sun
Java 6 will resolve this issue and you can then reinstall the ADT
Plugin.</p>


<h2 id="next">After Installation: Next Steps</h2>
<p>Once you have installed the SDK and the ADT Plugin, you are ready to
begin developing applications. Here are a few ways you can get started: </p>

<p><strong>Learn about Android</strong></p>
<ul>
<li>Take a look at the <a href="{@docRoot}guide/index.html">Dev
Guide</a> and the types of information it provides</li>
<li>Read an introduction to Android as a platform in <a
href="{@docRoot}guide/basics/what-is-android.html">What is
Android?</a></li>
<li>Learn about the Android framework and how applications run on it in
<a href="{@docRoot}guide/topics/fundamentals.html">Application
Fundamentals</a></li>
<li>Take a look at the Android framework API specification in the <a
href="{@docRoot}reference/index.html">Reference</a> tab</li>
</ul>

<p><strong>Explore the SDK</strong></p>
<ul>
<li>Get an overview of the <a
href="{@docRoot}guide/developing/tools/index.html">development
tools</a> that are available to you</li>
<li>Read the overviews of how to develop <a
href="{@docRoot}guide/developing/eclipse-adt.html">in Eclipse/ADT</a> or
<a href="{@docRoot}guide/developing/other-ide.html">in other IDEs</a>
</li>
</ul>

<p><strong>Explore some code</strong></p>
<ul>
<li>Set up a <a href="{@docRoot}guide/tutorials/hello-world.html">Hello
World application</a></li>
<li>Follow the <a href="{@docRoot}guide/tutorials/notepad/index.html">
Notepad Tutorial</a> to build a full Android application </li>
<li>Create a new project for one of the other sample applications
included in <code>&lt;sdk&gt;/samples</code>, then compile and run it in
your development environment</li>
</ul>

<p><strong>Visit the Android developer groups</strong></p>
<ul>
<li>Take a look at the <a
href="{@docRoot}community/index.html">Community</a> tab to see a list of
Android developers groups. In particular, you might want to look at the
<a href="http://groups.google.com/group/android-developers">Android
Developers</a> group to get a sense for what the Android developer
community is like.</li>
</ul>


<h2 id="installnotes">Installation Notes</h2>
<h4>Ubuntu Linux Notes</h4>
<ul>
    <li>If you need help installing and configuring Java on your
development machine, you might find these resources helpful: 
        <ul>
           <li><a href="https://help.ubuntu.com/community/Java">https://help.ubuntu.com/community/Java </a></li>
           <li><a href="https://help.ubuntu.com/community/Java">https://help.ubuntu.com/community/JavaInstallation </a></li>
       </ul>
   </li>
<li>Here are the steps to install Java and Eclipse, prior to installing
the Android SDK and ADT Plugin.
<ol>
    <li>If you are running a 64-bit distribution on your development
machine, you need to install the <code>ia32-libs</code> package using
<code>apt-get:</code>:
        <pre>apt-get install ia32-libs</pre></li>
    <li>Next, install Java:
        <pre>apt-get install sun-java6-bin</pre></li>
    <li>The Ubuntu package manager does not currently offer an Eclipse 3.3
    version for download, so we recommend that you download Eclipse from
eclipse.org (<a
href="http://www.eclipse.org/downloads/">http://www.eclipse.org/
downloads/</a>). A Java or RCP version of Eclipse is recommended.</li>
<li>Follow the steps given in previous sections to install the SDK 
and the ADT plugin. </li>
</ol>
</ul>
<h4>Other Linux Notes</h4>
<ul>
    <li>If JDK is already installed on your development computer, please
take a moment to make sure that it meets the version requirements listed
in the <a href="{@docRoot}sdk/1.1_r1/requirements.html">System Requirements</a>.
In particular, note that some Linux distributions may include JDK 1.4 or Gnu
Compiler for Java, both of which are not supported for Android development.</li>
</ul>