SailfishOS first application: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
[[Category:SailfishOS::Introduction_tutorial]]
[[Category:SailfishOS::Introduction_tutorial]]


[toc align_right="yes" depth="2"]
[toc align_right="yes" depth="2"]


'''English''' | [[:SailfishOS_first_application_Polish|Polski]]
'''English''' | [[:SailfishOS_first_application_Polish|Polski]]


''''_<br />Article is part 2 of &quot;Introduction Tutorial&amp;quot;:/wiki/Category:SailfishOS::Introduction_tutorial.<br />&quot;&lt; Go To Part 1&amp;quot;:/wiki/SailfishOS_SDK_Installation ||| &quot;Go To Part 3 &gt;&quot;:/wiki/SailfishOS_using_app_in_emulator_basics<br />''''_
''''_
Article is part 2 of "Introduction Tutorial":/wiki/Category:SailfishOS::Introduction_tutorial.
"< Go To Part 1":/wiki/SailfishOS_SDK_Installation ||| "Go To Part 3 >":/wiki/SailfishOS_using_app_in_emulator_basics
''''_


= First application =
= First application =


''if you don't have the SDK installed and running yet, follow the'' &quot;installation guide.&quot;:/wiki/SailfishOS_SDK_Installation
''if you don't have the SDK installed and running yet, follow the'' "installation guide.":/wiki/SailfishOS_SDK_Installation


== 1.Launch Sailfish OS IDE ==
== 1.Launch Sailfish OS IDE ==
Line 22: Line 25:


# In the IDE, click on File→New File or Project
# In the IDE, click on File→New File or Project
# Select Applications→SailfishOS Qt Quick Application.<br />[[Image:http://i.imgur.com/wmXnFos.png?2|Select application screenshot]]
# Select Applications→SailfishOS Qt Quick Application.
# Give a name to your project. Ensure it is created somewhere under your home directory and click Next.<br />[[Image:http://i.imgur.com/woU1BS0.png?2|Nameapplication screenshot]]
[[Image:http://i.imgur.com/wmXnFos.png?2|Select application screenshot]]
# Select MerSDK-SailfishOS-i486-x86 or MerSDK-SailfishOS-armv7hl kit and click Next.<br />''What's the diffrence? Generally MerSDK-SailfishOS-i486-x86 kit is used when deploying your application on emulator, the second kit is used when deploying application on Mer ARM device.''<br />[[Image:http://i.imgur.com/LV3atKp.png?2|Select kit screenshot]]
# Give a name to your project. Ensure it is created somewhere under your home directory and click Next.
# You can edit the short description of your project or just click Next<br />[[Image:http://i.imgur.com/7YPwbVc.png?2|Edit description screenshot]]
[[Image:http://i.imgur.com/woU1BS0.png?2|Nameapplication screenshot]]
# You can add version control to your project(in example GIT or SVN)<br />[[Image:http://i.imgur.com/lprPc7M.png?2|Add version controll system screenshot]]
# Select MerSDK-SailfishOS-i486-x86 or MerSDK-SailfishOS-armv7hl kit and click Next.
''What's the diffrence? Generally MerSDK-SailfishOS-i486-x86 kit is used when deploying your application on emulator, the second kit is used when deploying application on Mer ARM device.''
[[Image:http://i.imgur.com/LV3atKp.png?2|Select kit screenshot]]
# You can edit the short description of your project or just click Next
[[Image:http://i.imgur.com/7YPwbVc.png?2|Edit description screenshot]]
# You can add version control to your project(in example GIT or SVN)
[[Image:http://i.imgur.com/lprPc7M.png?2|Add version controll system screenshot]]
# Click Finish
# Click Finish
# The project template is imported into your project and opened in the editor.<br />[[Image:http://i.imgur.com/OYyvFEK.png?2|Glance at project template screenshot]]
# The project template is imported into your project and opened in the editor.
[[Image:http://i.imgur.com/OYyvFEK.png?2|Glance at project template screenshot]]


== 3. Launch the Mer build machine and Emulator ==
== 3. Launch the Mer build machine and Emulator ==
Line 36: Line 46:
''Note: The Mer build machine needs access to your source code to compile it and by default your home directory is shared - this is why the project should be in your home.''
''Note: The Mer build machine needs access to your source code to compile it and by default your home directory is shared - this is why the project should be in your home.''


When a Sailfish OS project is open, the SDK automatically displays two control buttons in the left toolbar for starting/stopping the Mer build machine and Emulator.<br />[[Image:http://i.imgur.com/0vAckoW.png|Mer build toolbar screenshot]]
When a Sailfish OS project is open, the SDK automatically displays two control buttons in the left toolbar for starting/stopping the Mer build machine and Emulator.
[[Image:http://i.imgur.com/0vAckoW.png|Mer build toolbar screenshot]]


=== 3.1. Click on the [[Image:http://i.imgur.com/nSniuw6.png|launch Mer Build Engine icon screenshot]] icon to launch Mer Build Engine. ===
=== 3.1. Click on the [[Image:http://i.imgur.com/nSniuw6.png|launch Mer Build Engine icon screenshot]] icon to launch Mer Build Engine. ===
Line 44: Line 55:
=== 3.2.— Click on the [[Image:http://i.imgur.com/zzawOqw.png| launch the emulator icon screenshot]] icon to launch the emulator. ===
=== 3.2.— Click on the [[Image:http://i.imgur.com/zzawOqw.png| launch the emulator icon screenshot]] icon to launch the emulator. ===


A new VirtualBox window opens and boots up the emulator.<br />[[Image:http://i.imgur.com/SP9eCDT.png?1| working emulator screenshot]]
A new VirtualBox window opens and boots up the emulator.
[[Image:http://i.imgur.com/SP9eCDT.png?1| working emulator screenshot]]


== 4. Successful connection ==
== 4. Successful connection ==
Line 50: Line 62:
When the QtCreator can successfully connect to both the emulator and Mer build machine, the icons are updated as shown below.
When the QtCreator can successfully connect to both the emulator and Mer build machine, the icons are updated as shown below.


Before connection:<br />[[Image:http://i.imgur.com/ifAYFRi.png| Before connection screenshot]]
Before connection:
[[Image:http://i.imgur.com/ifAYFRi.png| Before connection screenshot]]


Connection established:<br />[[Image:http://i.imgur.com/tQe3Og8.png| Connection established screenshot]]
Connection established:
[[Image:http://i.imgur.com/tQe3Og8.png| Connection established screenshot]]


== 5. Build and Deploy the app ==
== 5. Build and Deploy the app ==
Line 58: Line 72:
Press the [[Image:http://i.imgur.com/aI9ECKM.png| play/run button screenshot]] play/run button in the toolbar to compile and run the project on the emulator.
Press the [[Image:http://i.imgur.com/aI9ECKM.png| play/run button screenshot]] play/run button in the toolbar to compile and run the project on the emulator.


That's it. Congratulations! You just ran your first SailfishOS application. It should be running in the emulator as shown below:<br />[[Image:http://i.imgur.com/wJ4tqvy.png?1| working emulator screenshot]]
That's it. Congratulations! You just ran your first SailfishOS application. It should be running in the emulator as shown below:
[[Image:http://i.imgur.com/wJ4tqvy.png?1| working emulator screenshot]]


''''_<br />Article is part 2 of &quot;Introduction Tutorial&amp;quot;:/wiki/Category:SailfishOS::Introduction_tutorial.<br />&quot;&lt; Go To Part 1&amp;quot;:/wiki/SailfishOS_SDK_Installation ||| &quot;Go To Part 3 &gt;&quot;:/wiki/SailfishOS_using_app_in_emulator_basics<br />''''_
''''_
Article is part 2 of "Introduction Tutorial":/wiki/Category:SailfishOS::Introduction_tutorial.
"< Go To Part 1":/wiki/SailfishOS_SDK_Installation ||| "Go To Part 3 >":/wiki/SailfishOS_using_app_in_emulator_basics
''''_

Revision as of 10:30, 25 February 2015


[toc align_right="yes" depth="2"]

English | Polski

'_ Article is part 2 of "Introduction Tutorial":/wiki/Category:SailfishOS::Introduction_tutorial. "< Go To Part 1":/wiki/SailfishOS_SDK_Installation ||| "Go To Part 3 >":/wiki/SailfishOS_using_app_in_emulator_basics '_

First application

if you don't have the SDK installed and running yet, follow the "installation guide.":/wiki/SailfishOS_SDK_Installation

1.Launch Sailfish OS IDE

You can launch from the 'SailfishOS IDE' entry in the system menu (or from ~/SailfishOS/bin/qtcreator if you're a linux terminal person).

As an example, on Ubuntu, open the dash, type in 'sailfish'. Click on the 'SailfishOS IDE' icon to launch the IDE.

2. Create a Sailfish UI project

The SDK comes with a Sailfish UI template project that makes it very easy to get started. Dialog windows shown in screenshots may vary between diffrent versions/systems so treat them as a example.

  1. In the IDE, click on File→New File or Project
  2. Select Applications→SailfishOS Qt Quick Application.

Select application screenshot

  1. Give a name to your project. Ensure it is created somewhere under your home directory and click Next.

Nameapplication screenshot

  1. Select MerSDK-SailfishOS-i486-x86 or MerSDK-SailfishOS-armv7hl kit and click Next.

What's the diffrence? Generally MerSDK-SailfishOS-i486-x86 kit is used when deploying your application on emulator, the second kit is used when deploying application on Mer ARM device. Select kit screenshot

  1. You can edit the short description of your project or just click Next

Edit description screenshot

  1. You can add version control to your project(in example GIT or SVN)

Add version controll system screenshot

  1. Click Finish
  2. The project template is imported into your project and opened in the editor.

Glance at project template screenshot

3. Launch the Mer build machine and Emulator

The SailfishOS SDK uses a Mer build machine to compile your code and another virtual machine to run an emulator. If these are not running when you attempt to build or deploy an application you will be asked to start them.

Note: The Mer build machine needs access to your source code to compile it and by default your home directory is shared - this is why the project should be in your home.

When a Sailfish OS project is open, the SDK automatically displays two control buttons in the left toolbar for starting/stopping the Mer build machine and Emulator. Mer build toolbar screenshot

3.1. Click on the launch Mer Build Engine icon screenshot icon to launch Mer Build Engine.

The Mer Build Engine is started in the background and the icon will turn gray until the machine has booted up.

3.2.— Click on the launch the emulator icon screenshot icon to launch the emulator.

A new VirtualBox window opens and boots up the emulator. working emulator screenshot

4. Successful connection

When the QtCreator can successfully connect to both the emulator and Mer build machine, the icons are updated as shown below.

Before connection: Before connection screenshot

Connection established: Connection established screenshot

5. Build and Deploy the app

Press the play/run button screenshot play/run button in the toolbar to compile and run the project on the emulator.

That's it. Congratulations! You just ran your first SailfishOS application. It should be running in the emulator as shown below: working emulator screenshot

'_ Article is part 2 of "Introduction Tutorial":/wiki/Category:SailfishOS::Introduction_tutorial. "< Go To Part 1":/wiki/SailfishOS_SDK_Installation ||| "Go To Part 3 >":/wiki/SailfishOS_using_app_in_emulator_basics '_