Developer Guide for MeeGo 1.1

Latest revision as of 10:37, 14 April 2011

Contents of this page

This site is used for mapping documentation for application developers about MeeGo 1.1 documentation release. Eventually, the page will contain links to all relevant MeeGo 1.1 developer documentation content.

Please be patient while the content on this page is being updated.

Note that this page will not link to any other documentation, such as

• instructions about writing documentation
• platform development instructions
• process descriptions describing how MeeGo OS work is carried out

Content drafts for MeeGo 1.1

• If you are currently working on draft material for MeeGo 1.1, add links to all the pages you are updating, here.
• If you cannot find a category (heading) describing the item you are working on, create a new one. Add also 1) a description of the purpose of the page(s) 2) location of page 3) links to source material that will become outdated when your page is ready 4) content status for MeeGo 1.1 release
• TIP: see the list of pages in the next section. If you see pages that are related to the content you are working on, check to see if they should be moved to this section as content to be archived after release(remember to delete from the possible update needs list).
• Legend: colours represent the state of the document:
  • Done and ready for MeeGo 1.1 documentation review.
  • Currently being updated
  • Merged into another document, or no longer required; should be archived into previous version of docs

Current developer guide TOC for MeeGo 1.1

SDK/Docs/1.1

Release notes

Area owners: Bob, Veli

Description: Release notes page providing info on tools versions, default features, system requirements, and known issues in the release.

Link: SDK/Docs/1.1/Release notes

Old content to be archived after release: N/A

Status: draft done and ready for MeeGo 1.1 documentation review, moved to correct location after review.

Introduction

Area owners: Ronan

Description: Introductory materials providing an overview of the release, description on what it provides for developers. Also links and introductions to different websites containing information related to the release. To also include an overview to native vs. web side.

Link(s): <add links>

• SDK/Docs/1.1/MeeGo developer story (Developer story update -> on a more general level, not tied to a specific release.) - Elliot Smith - I added some material here; should also include content from MeeGo SDK Development Options; Bob Spencer is going to do the merge - I did a draft of the updated Developer Story www.meego.com - at a similar abstract level as before, comments welcome Ronan Mac Laverty
• SDK/Docs/1.1/MeeGo_overview (Description of developer offering for 1.1, containing an overview of MeeGo websites and their purpose) - ready for review Ronan Mac Laverty

Old content to be archived after release:

• draft version Application developer site/Draft content/Community
• http://meego.com/developers/meego-developer-story

Status: In review.

Architecture overview

Area owners: Titta

Description: Introduction to MeeGo 1.1 architecture with picture(s) illustrating the architectural composition.

Link(s): <add links>

• http://meego.com/developers/meego-architecture
• http://meego.com/developers/meego-architecture/meego-architecture-layer-view
• http://meego.com/developers/meego-architecture/meego-architecture-domain-view
• http://meego.com/developers/meego-architecture/meego-architecture-api-view

Old content to be archived after release: Old content has already been removed.

Status: drafts done and ready for MeeGo 1.1 documentation review.

UI guidelines

Area owners: Elliot

Description: UI and user experience guidelines on things to consider when designing a handset application

Link(s):

• MeeGo User Experience Design Principles
• UI Design Guidelines

Old content to be archived after release: N/A

Status: ready for MeeGo 1.1 documentation review.

Getting started with MeeGo SDK for Linux

Area owners: Bob, Veli

Description: Instructions on installing MeeGo SDK on Linux, required configurations to get the development environment set up, running an application on simulator, emulator and device, and creating an RPM package.

Link(s):

• SDK/Docs/1.1/Getting started with the MeeGo SDK for Linux Includes instructions for installing and configuring MeeGo 1.1 development environment on Linux. ready
• Setting up your device for application development
  • Setting up N900 device Includes information on installing MeeGo image and configuring device access for N900. ready
  • Setting up Aava Information on installing MeeGo image and configuring device access for Aava. Kerry working on this.
  • Setting up Netbook Includes info on installing MeeGo image and configuring device access; Qt Creator setup is copied from N900 page. Elliot ready
• Developing for MeeGo Includes short description of dev workflow: Analysis, Designing, Coding, Building and packaging). Bob + Ronan to comment on how to finalize this page.
• Creating Hello World This section describes how to create, package and run your first application on a device.

  Elliot removed debugging section again 2010-10-29 ready

• Debugging This section describes how to debug your application in Qt Creator.

  Elliot ready

• SDK/Docs/1.1/Configuring QEMU runtimes This covers setting up a QEMU runtime.

  Elliot the IA32 parts are written, using MADDE to setup and start the runtimes; the runtimes are now up to date //Titta: we need Intel QEMU instructions, here, Fathi making updates for ARM QEMU.

• SDK/Docs/1.1/MeeGo SDK with Xephyr

  Elliot - updated and verified, as this is currently the main viable approach to simulating MeeGo (on Linux only)

• SDK/Docs/1.1/Building a MeeGo chroot on Linux

  Elliot updated and verified; linked to from SDK/Docs/1.1/MeeGo SDK with Xephyr so needed on developer site

• SDK/Docs/1.1/MeeGo SDK Graphics Acceleration

  Elliot copied from http://wiki.meego.com/MeeGo_SDK_Graphics_Acceleration; ready to go; required for checking whether QEMU will work

Old content to be archived after release:

• Getting started with the MeeGo SDK for Linux - should be deleted
  • • MeeGo_SDK_with_QEMU#Use_Qt_Creator_to_Develop_MeeGo_Applications (is this going to be moved into its own page?)
  • SDK/Testing#Install
  • SDK/Testing#Configure_MADDE
  • ARM/N900/Install/chroot
  • MeeGo_SDK_Development_Guide
  • Developer_tools
• SDK/Docs/1.0/Packaging MeeGo applications
• SDK/Docs/1.1/Debugging for N900 device: This page is no longer necessary, it can be archived after the MeeGo 1.1 release.

Status: Work on drafts ongoing. Drafts cannot be finalized or reviewed before tool updates for the release are frozen.

Getting started with MeeGo SDK for Windows

Area owners: Bob, Veli

Description: Instructions on installing MeeGo SDK on Windows, required configurations to get the development environment set up, running an application on simulator, emulator and device, and creating an RPM package.

Link(s):

Old content to be archived after release:

• MeeGo_SDK_for_Windows - gone -- Elliot Smith 15:27, 6 January 2011 (UTC)
• MeeGo_SDK_for_Windows_Installer - gone -- Elliot Smith 15:27, 6 January 2011 (UTC)

Status: Work on drafts ongoing. Drafts cannot be finalized or reviewed before tool updates and installer are ready.

Examples (and tools instructions)

Area owners: Elliot, Kerry

Description: Links to example applications relevant for the MeeGo 1.1 release. Also includes instructions for using tools.

Link(s):

• SDK/Docs/1.1/MeeGo SDK with Qt - Elliot Smith created a landing page for Qt but focused on its use in a MeeGo context; added instructions for running examples and finding sample source
• SDK/Docs/1.1/Web SDK with WRT - Elliot Smith updated; Windows-focused, as package for my OS (Fedora) isn't available; will probably be superseded by docs in the WebSDK itself; added some instructions about installing and running examples
• SDK/Docs/1.1/Debugging with Qt Creator - Elliot Smith finally managed to complete this, verified for Fedora 13 with meego-sdk-qt-creator 2.0.1-21.1 + MADDE 0.7.53-20.1 + ia32 sysroot, deploying to and remote debugging on real MeeGo netbook with image 1.1.80.2.20101019.1

Old content to be archived after release:

Status:

API reference

Area owners: Murali

Description: API reference library allowing you to browse MeeGo API documentation online. Introductory content on API offering.

Link(s):

//the following short intro to be placed here http://apidocs.meego.com/1.1-api-preview/ //

MeeGo 1.1 release provides two API reference libraries for development work:

• MeeGo API includes the official API set for MeeGo application development. For MeeGo API, compatibility with future MeeGo releases is guaranteed.
• MeeGo Platform API extends the official MeeGo API by providing additional functionalities. However, Platform API does not come with a compatibility guarantee with future MeeGo releases.

Old content to be archived after release:

• http://meego.com/developers/meego-api //update the intro? //

• ' updated content for MeeGo Platform API reference

Status: Draft in review.

Terminology

Area owners: Titta

Description: A release-specific terminology page + update to the general glossary page

Link(s): SDK/Docs/1.1/Terminology

Old content to be archived after release: N/A

Status: DRAFT, to be reviewed. Updates to main glossary made after this (applicable parts).

Possible update needs

If you are working on draft material for MeeGo 1.1, please go through the below list to check if you should be updating some of the pages. Move links to the section above, if needed. Note that the list currently also includes also items that are not (directly) relevant for MeeGo 1.1 application developers. If you spot such links, mark them with N/A

• Guide_to_the_MeeGo_developer_library
• http://meego.com/developers/meego-developer-story
• http://meego.com/developers/meego-api
• http://build.meego.com/
• Build_Infrastructure
• Release_Infrastructure
• http://meego.gitorious.org/
• http://repo.meego.com/
• MeeGo_Touch_Framework - Elliot Smith should we copy this over to the SDK docs, or just link out to it so it can stay on the wiki?
• Application_developer_site/DraftContent/Introduction/Ecosystem
• Application_developer_site/DraftContent/Introduction/Highlights
• Application_developer_site/DraftContent/Introduction/Demos
• Application_developer_site/DraftContent/Introduction
• MeeGo_Emulator_QEMU
• MeeGo_SDK_All_in_One
• MeeGo_Porting_Guide N/A aimed at projects taking meego to use on new hardware
• SDK/Docs/1.1/Building QEMU Tools - Elliot Smith updated and verified
• Developing_in_a_Meego_Environment N/A
• Handset_Design_Guide N/A //not in scope for 1.1//

• SDK/Docs/1.0/Hello_World_-_MeeGo_x86_development_on_Linux - Elliot Smith - I moved useful content from this page to SDK/Docs/1.1/Debugging with Qt Creator and SDK/Docs/1.1/MeeGo SDK with Xephyr, so this page can be archived now
• MeeGo_SDK_Development_Options - Elliot Smith should be archived as content is out of sync with 1.1
• MeeGo_SDK_with_Stock_Images - Elliot Smith merged with SDK/Docs/1.1/Building_a_MeeGo_chroot_on_Linux, so this page can be archived into SDK/Docs/1.0 now