blob: 4bd92ee751459ad6ed5d1de647ab739a5ab7d714 [file] [log] [blame]
page.title=Creating an Android Project
page.tags=project setup
next.title=Running Your App
<!-- This is the training bar -->
<div id="tb-wrapper">
<div id="tb">
<h2>This lesson teaches you to</h2>
<li><a href="#Studio">Create a Project with Android Studio</a></li>
<li><a href="#CommandLine">Create a Project with Command Line Tools</a></li>
<h2>You should also read</h2>
<li><a href="{@docRoot}tools/projects/index.html">Managing Projects</a></li>
<p>An Android project contains all the files that comprise the source code for your Android
<p>This lesson
shows how to create a new project either using Android Studio or using the
SDK tools from a command line.</p>
<p class="note"><strong>Note:</strong> You should already have the Android SDK installed, and if
you're using Android Studio, you should also have <a href="{@docRoot}sdk/installing/studio.html">
Android Studio</a> installed. If you don't have these, follow the guide to <a
href="{@docRoot}sdk/installing/index.html">Installing the Android SDK</a> before you start this
<h2 id="Studio">Create a Project with Android Studio</h2>
<li>In Android Studio, create a new project:
<li>If you don't have a project opened, in the <strong>Welcome</strong> screen, click <strong>
New Project</strong>.</li>
<li>If you have a project opened, from the <strong>File</strong> menu, select <strong>New
<div class="figure" style="width:420px">
<img src="{@docRoot}images/training/firstapp/studio-setup-1.png" alt="" />
<p class="img-caption"><strong>Figure 1.</strong> Configuring a new project in Android Studio.</p>
<li>Under <strong>Configure your new project</strong>, fill in the fields as shown in figure 1
and click <strong>Next</strong>.
<p>It will probably be easier to follow these lessons if you use the same values as shown.</p>
<li><strong>Application Name</strong> is the app name that appears to users.
For this project, use "My First App."</li>
<li><strong>Company domain</strong> provides a qualifier that will be appended to the package
name; Android Studio will remember this qualifier for each new project you create.</li>
<li><strong>Package name</strong> is the fully qualified name for the project (following the
same rules as those for naming packages in the Java programming language). Your package name
must be unique across all packages installed on the Android system. You can <strong>
Edit</strong> this value independently from the application name or the company
<li><strong>Project location</strong> is the directory on your system that holds the project
<li>Under <strong>Select the form factors your app will run on</strong>, check the box for <strong>
Phone and Tablet</strong>.</li>
<li>For <strong>Minimum SDK</strong>, select <strong>API 8: Android 2.2 (Froyo)</strong>.
<p>The Minimum Required SDK is the earliest version of Android that your app supports,
indicated using the <a href="{@docRoot}guide/topics/manifest/uses-sdk-element.html#ApiLevels">
API level</a>. To support as many devices as possible, you should set this to the lowest
version available that allows your app to provide its core feature set. If any feature of your
app is possible only on newer versions of Android and it's not critical to the app's core
feature set, you can enable the feature only when running on the versions that support it (as
discussed in <a href="{@docRoot}training/basics/supporting-devices/platforms.html">
Supporting Different Platform Versions</a>).</p></li>
<li>Leave all of the other options (TV, Wear, and Glass) unchecked and click <strong>Next.</strong></li>
<div class="sidebox-wrapper">
<div class="sidebox">
<p>An activity is one of the distinguishing features of the Android framework. Activities
provide the user with access to your app, and there may be many activities. An application
will usually have a main activity for when the user launches the application, another
activity for when she selects some content to view, for example, and other activities for
when she performs other tasks within the app. See <a href="{@docRoot}guide/components/activities.html">
Activities</a> for more information.</p>
<li>Under <strong>Add an activity to &lt;<em>template</em>&gt;</strong>, select <strong>Blank
Activity</strong> and click <strong>Next</strong>.</li>
<li>Under <strong>Choose options for your new file</strong>, change the
<strong>Activity Name</strong> to <em>MyActivity</em>. The <strong>Layout Name</strong> changes
to <em>activity_my</em>, and the <strong>Title</strong> to <em>MyActivity</em>. The
<strong>Menu Resource Name</strong> is <em>menu_my</em>.
<li>Click the <strong>Finish</strong> button to create the project.</li>
<p>Your Android project is now a basic "Hello World" app that contains some default files. Take a
moment to review the most important of these:</p>
<dd>This is the XML layout file for the activity you added when you created the project with Android
Studio. Following the New Project workflow, Android Studio presents this file with both a text
view and a preview of the screen UI. The file includes some default settings and a <code>TextView</code>
element that displays the message, "Hello world!"</dd>
<dd>A tab for this file appears in Android Studio when the New Project workflow finishes. When you
select the file you see the class definition for the activity you created. When you build and
run the app, the {@link} class starts the activity and loads the layout file
that says "Hello World!"</dd>
<dd>The <a href="{@docRoot}guide/topics/manifest/manifest-intro.html">manifest file</a> describes
the fundamental characteristics of the app and defines each of its components. You'll revisit
this file as you follow these lessons and add more components to your app.</dd>
<dd>Android Studio uses Gradle to compile and build your app. There is a <code>build.gradle</code>
file for each module of your project, as well as a <code>build.gradle</code> file for the entire
project. Usually, you're only interested in the <code>build.gradle</code> file for the module,
in this case the <code>app</code> or application module. This is where your app's build dependencies
are set, including the <code>defaultConfig</code> settings:
<li><code>compiledSdkVersion</code> is the platform version against which you will compile
your app. By default, this is set to the latest version of Android available in your SDK.
(It should be Android 4.1 or greater; if you don't have such a version available, you must
install one using the <a href="{@docRoot}sdk/installing/adding-packages.html">SDK Manager</a>.)
You can still build your app to support older versions, but setting this to the latest
version allows you to enable new features and optimize your app for a great user experience
on the latest devices.</li>
<li><code>applicationId</code> is the fully qualified package name for your application that
you specified during the New Project workflow.</li>
<li><code>minSdkVersion</code> is the Minimum SDK version you specified during the New Project
workflow. This is the earliest version of the Android SDK that your app supports.</li>
<li><code>targetSdkVersion</code> indicates the highest version of Android with which you have
tested your application. As new versions of Android become available, you should
test your app on the new version and update this value to match the latest API level and
thereby take advantage of new platform features. For more information, read
<a href="{@docRoot}training/basics/supporting-devices/platforms.html">Supporting Different
Platform Versions</a>.</li>
<p>See <a href="{@docRoot}sdk/installing/studio-build.html">Building Your Project with Gradle</a>
for more information about Gradle.</p></dd>
<p>Note also the <code>/res</code> subdirectories that contain the
<a href="{@docRoot}guide/topics/resources/overview.html">resources</a> for your application:</p>
<dd>Directories for drawable objects (such as bitmaps) that are designed for various densities,
such as medium-density (mdpi) and high-density (hdpi) screens. Other drawable directories
contain assets designed for other screen densities.
Here you'll find the ic_launcher.png that appears when you run the default app.</dd>
<dd>Directory for files that define your app's user interface like activity_my.xml,
discussed above, which describes a basic layout for the MyActivity class.</dd>
<dd>Directory for files that define your app's menu items.</dd>
<dd>Directory for other XML files that contain a collection of resources, such as
string and color definitions. The strings.xml file defines the "Hello world!" string that
displays when you run the default app.</dd>
<p>To run the app, continue to the <a href="running-app.html">next lesson</a>.</p>
<h2 id="CommandLine">Create a Project with Command Line Tools</h2>
<p>If you're not using the Android Studio IDE, you can instead create your project
using the SDK tools from a command line:</p>
<li>Change directories into the Android SDK’s <code>sdk/</code> path.</li>
<pre class="no-pretty-print">tools/android list targets</pre>
<p>This prints a list of the available Android platforms that you’ve downloaded for your SDK. Find
the platform against which you want to compile your app. Make a note of the target ID. We
recommend that you select the highest version possible. You can still build your app to
support older versions, but setting the build target to the latest version allows you to optimize
your app for the latest devices.</p>
<p>If you don't see any targets listed, you need to
install some using the Android SDK
Manager tool. See <a href="{@docRoot}sdk/installing/adding-packages.html">Adding SDK
<pre class="no-pretty-print">
android create project --target &lt;target-id> --name MyFirstApp \
--path &lt;path-to-workspace>/MyFirstApp --activity MyActivity \
--package com.example.myfirstapp
<p>Replace <code>&lt;target-id></code> with an ID from the list of targets (from the previous step)
and replace
<code>&lt;path-to-workspace></code> with the location in which you want to save your Android
<p class="note"><strong>Tip:</strong> Add the <code>platform-tools/</code> as well as the
<code>tools/</code> directory to your <code>PATH</code> environment variable.</p>
<p>Your Android project is now a basic "Hello World" app that contains some default files.
To run the app, continue to the <a href="running-app.html">next lesson</a>.</p>