(→Getting started with MeeGo SDK for Linux) |
m (→Terminology: wikify link) |
||
| (31 intermediate revisions not shown) | |||
| Line 4: | Line 4: | ||
== Contents of this page == | == Contents of this page == | ||
| - | This site is used for mapping documentation for application developers about | + | 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.''' | '''Please be patient while the content on this page is being updated.''' | ||
| Line 12: | Line 12: | ||
* platform development instructions | * platform development instructions | ||
* process descriptions describing how MeeGo OS work is carried out | * process descriptions describing how MeeGo OS work is carried out | ||
| - | |||
== Content drafts for MeeGo 1.1 == | == Content drafts for MeeGo 1.1 == | ||
| Line 24: | Line 23: | ||
** <span style="color:gray;">Merged into another document, or no longer required; should be archived into previous version of docs</span> | ** <span style="color:gray;">Merged into another document, or no longer required; should be archived into previous version of docs</span> | ||
| + | == Current developer guide TOC for MeeGo 1.1 == | ||
| + | |||
| + | [[SDK/Docs/1.1]] | ||
=== Release notes === | === Release notes === | ||
| Line 38: | Line 40: | ||
'''Status:''' | '''Status:''' | ||
| - | + | <span style="color:green;">draft done and ready for MeeGo 1.1 documentation review, moved to correct location after review.</span> | |
| - | + | ||
| Line 49: | Line 50: | ||
'''Link(s):''' <add links> | '''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.) - [[User:Elliot|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 [[User:macron|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) - <span style="color: | + | * [[SDK/Docs/1.1/MeeGo_overview]] (Description of developer offering for 1.1, containing an overview of MeeGo websites and their purpose) - <span style="color:green;"> ready for review [[User:macron|Ronan Mac Laverty]]</span> |
'''Old content to be archived after release:''' | '''Old content to be archived after release:''' | ||
| - | * draft version | + | * draft version [[Application developer site/Draft content/Community]] |
* http://meego.com/developers/meego-developer-story | * http://meego.com/developers/meego-developer-story | ||
'''Status:''' | '''Status:''' | ||
| - | + | In review. | |
=== Architecture overview === | === Architecture overview === | ||
| Line 66: | Line 67: | ||
'''Link(s):''' <add links> | '''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 to be archived after release:''' | ||
| - | + | Old content has already been removed. | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
'''Status:''' | '''Status:''' | ||
| - | + | <span style="color:green;">drafts done and ready for MeeGo 1.1 documentation review.</span> | |
=== UI guidelines === | === UI guidelines === | ||
| Line 92: | Line 93: | ||
'''Status:''' | '''Status:''' | ||
| - | + | <span style="color:green;">ready for MeeGo 1.1 documentation review.</span> | |
=== Getting started with MeeGo SDK for Linux === | === Getting started with MeeGo SDK for Linux === | ||
| Line 101: | Line 102: | ||
'''Link(s):''' | '''Link(s):''' | ||
| - | * [[SDK/Docs/1.1/Getting started with the MeeGo SDK for Linux]] | + | * [[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. <span style="color:green;">ready</span> |
| - | + | * '''Setting up your device for application development''' | |
| - | ** | + | ** [[SDK/Docs/1.1/Setting_up_N900_device | Setting up N900 device]] Includes information on installing MeeGo image and configuring device access for N900. <span style="color:green;">ready</span> |
| - | + | ** [[SDK/Docs/1.1/Setting_up_Aava| Setting up Aava]] Information on installing MeeGo image and configuring device access for Aava. <span style="color:orange;">Kerry working on this.</span> | |
| - | + | ** [[SDK/Docs/1.1/Setting_up_Netbook | Setting up Netbook]] Includes info on installing MeeGo image and configuring device access; Qt Creator setup is copied from N900 page. <span style="color:green;">[[User:Elliot|Elliot]] ready</span> | |
| - | * [[SDK/Docs/1.1/Developing_for_MeeGo|Developing for MeeGo]] | + | * [[SDK/Docs/1.1/Developing_for_MeeGo|Developing for MeeGo]] Includes short description of dev workflow: Analysis, Designing, Coding, Building and packaging). <span style="color:green;"> Bob + Ronan to comment on how to finalize this page. </span> |
| - | + | ||
* [[SDK/Docs/1.1/Creating_Hello_World | Creating Hello World]] This section describes how to create, package and run your first application on a device. | * [[SDK/Docs/1.1/Creating_Hello_World | Creating Hello World]] This section describes how to create, package and run your first application on a device. | ||
| - | *: <span style="color:green;">[[User:Elliot|Elliot]] | + | *: [[User:Elliot|Elliot]] removed debugging section again 2010-10-29 <span style="color:green;">ready</span> |
| - | * [[SDK/Docs/1.1/Configuring QEMU | + | * [[SDK/Docs/1.1/Debugging_with_Qt_Creator | Debugging]] This section describes how to debug your application in Qt Creator. |
| - | *: <span style="color:orange;">[[User:Elliot|Elliot]] | + | *: <span style="color:green;">[[User:Elliot|Elliot]] ready</span> |
| - | * | + | * [[SDK/Docs/1.1/Configuring QEMU runtimes]] This covers setting up a QEMU runtime. |
| - | *: [[User:Elliot|Elliot]] - updated and verified, as this is currently the main viable approach to simulating MeeGo (on Linux only)</span> | + | *: <span style="color:orange;">[[User:Elliot|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.</span> |
| - | * | + | * [[SDK/Docs/1.1/MeeGo SDK with Xephyr]] |
| - | *: [[User:Elliot|Elliot]] updated and verified; linked to from [[SDK/Docs/1.1/MeeGo SDK with Xephyr]] so needed on developer site</span> | + | *: <span style="color:green;">[[User:Elliot|Elliot]] - updated and verified, as this is currently the main viable approach to simulating MeeGo (on Linux only)</span> |
| - | * | + | * [[SDK/Docs/1.1/Building a MeeGo chroot on Linux]] |
| - | *: [[User:Elliot|Elliot]] copied from http://wiki.meego.com/MeeGo_SDK_Graphics_Acceleration; ready to go; required for checking whether QEMU will work</span> | + | *: <span style="color:green;">[[User:Elliot|Elliot]] updated and verified; linked to from [[SDK/Docs/1.1/MeeGo SDK with Xephyr]] so needed on developer site</span> |
| - | + | * [[SDK/Docs/1.1/MeeGo SDK Graphics Acceleration]] | |
| + | *: <span style="color:green;">[[User:Elliot|Elliot]] copied from http://wiki.meego.com/MeeGo_SDK_Graphics_Acceleration; ready to go; required for checking whether QEMU will work</span> | ||
'''Old content to be archived after release:''' | '''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. |
| - | * [[SDK/Docs/1. | + | |
| - | * | + | |
'''Status:''' | '''Status:''' | ||
| Line 145: | Line 144: | ||
'''Old content to be archived after release:''' | '''Old content to be archived after release:''' | ||
| - | * | + | * [[MeeGo_SDK_for_Windows]] - gone -- [[User:Elliot|Elliot Smith]] 15:27, 6 January 2011 (UTC) |
| - | * | + | * [[MeeGo_SDK_for_Windows_Installer]] - gone -- [[User:Elliot|Elliot Smith]] 15:27, 6 January 2011 (UTC) |
'''Status:''' | '''Status:''' | ||
Work on drafts ongoing. Drafts cannot be finalized or reviewed before tool updates and installer are ready. | Work on drafts ongoing. Drafts cannot be finalized or reviewed before tool updates and installer are ready. | ||
| - | === Examples === | + | === Examples (and tools instructions) === |
'''Area owners:''' Elliot, Kerry | '''Area owners:''' Elliot, Kerry | ||
'''Description:''' Links to example applications relevant for the MeeGo 1.1 release. | '''Description:''' Links to example applications relevant for the MeeGo 1.1 release. | ||
| + | Also includes instructions for using tools. | ||
| + | |||
'''Link(s):''' | '''Link(s):''' | ||
* <span style="color:green;">[[SDK/Docs/1.1/MeeGo SDK with Qt]] - [[User:Elliot|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</span> | * <span style="color:green;">[[SDK/Docs/1.1/MeeGo SDK with Qt]] - [[User:Elliot|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</span> | ||
| - | * <span style="color:green;">[[SDK/Docs/1.1/ | + | * <span style="color:green;">[[SDK/Docs/1.1/Web SDK with WRT]] - [[User:Elliot|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</span> |
* <span style="color:green;">[[SDK/Docs/1.1/Debugging with Qt Creator]] - [[User:Elliot|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</span> | * <span style="color:green;">[[SDK/Docs/1.1/Debugging with Qt Creator]] - [[User:Elliot|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</span> | ||
| Line 174: | Line 175: | ||
'''Link(s):''' | '''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: | |
| - | + | ||
| + | * [http://apidocs.meego.com/1.1-api-preview/core/html/index.html MeeGo API] includes the official API set for MeeGo application development. For MeeGo API, compatibility with future MeeGo releases is guaranteed. | ||
| + | * [http://apidocs.meego.com/1.1-api-preview/platform/html/index.html 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? // | ||
| + | '' | ||
| + | * '''[[SDK/Docs/1.1/Platform_API| updated content for MeeGo Platform API reference]]'' | ||
'''Status:''' | '''Status:''' | ||
| - | + | Draft in review. | |
=== Terminology === | === Terminology === | ||
| Line 185: | Line 193: | ||
'''Area owners:''' Titta | '''Area owners:''' Titta | ||
| - | '''Description:''' A release-specific terminology page + update to the general glossary page | + | '''Description:''' A release-specific terminology page + update to the [[Glossary|general glossary page]] |
'''Link(s):''' [[SDK/Docs/1.1/Terminology]] | '''Link(s):''' [[SDK/Docs/1.1/Terminology]] | ||
| Line 198: | Line 206: | ||
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'' | 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-developer-story | ||
* http://meego.com/developers/meego-api | * http://meego.com/developers/meego-api | ||
* http://build.meego.com/ | * http://build.meego.com/ | ||
| - | * | + | * [[Build_Infrastructure]] |
| - | * | + | * [[Release_Infrastructure]] |
* http://meego.gitorious.org/ | * http://meego.gitorious.org/ | ||
* http://repo.meego.com/ | * http://repo.meego.com/ | ||
| - | * | + | * [[MeeGo_Touch_Framework]] - [[User:Elliot|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 |
| - | * <span style="color: | + | * <span style="color:green;">[[SDK/Docs/1.1/Building QEMU Tools]] - [[User:Elliot|Elliot Smith]] updated and verified</span> |
| - | * | + | * [[Developing_in_a_Meego_Environment]] ''N/A'' |
| - | * | + | * [[Handset_Design_Guide]] ''N/A'' //not in scope for 1.1// |
| + | |||
| + | * <span style="color:grey;"> [[SDK/Docs/1.0/Hello_World_-_MeeGo_x86_development_on_Linux]] - [[User:Elliot|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</span> | ||
| + | * <span style="color:gray;">[[MeeGo_SDK_Development_Options]] - [[User:Elliot|Elliot Smith]] should be archived as content is out of sync with 1.1</span> | ||
| + | * <span style="color:gray;">[[MeeGo_SDK_with_Stock_Images]] - [[User:Elliot|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</span> | ||
| - | + | [[Category:Meego-1.1]] | |
| - | + | ||
| - | + | ||
Contents |
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
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.
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>
Old content to be archived after release:
Status: In review.
Area owners: Titta
Description: Introduction to MeeGo 1.1 architecture with picture(s) illustrating the architectural composition.
Link(s): <add links>
Old content to be archived after release:
Old content has already been removed.
Status: drafts done and ready for MeeGo 1.1 documentation review.
Area owners: Elliot
Description: UI and user experience guidelines on things to consider when designing a handset application
Link(s):
Old content to be archived after release: N/A
Status: ready for MeeGo 1.1 documentation review.
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):
Old content to be archived after release:
Status: Work on drafts ongoing. Drafts cannot be finalized or reviewed before tool updates for the release are frozen.
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:
Status: Work on drafts ongoing. Drafts cannot be finalized or reviewed before tool updates and installer are ready.
Area owners: Elliot, Kerry
Description: Links to example applications relevant for the MeeGo 1.1 release. Also includes instructions for using tools.
Link(s):
Old content to be archived after release:
Status:
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:
Old content to be archived after release:
Status: Draft in review.
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).
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