Plasma/Mobile/Code: Difference between revisions

From KDE Community Wiki
< Plasma‎ | Mobile
(→‎Plasma: projects.kde.org > quickgit)
(Move notice)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Note|This page is now on [[https://community.kde.org/Plasma/Mobile/Code https://docs.plasma-mobile.org/]]}}
=Getting the Code =
You can check out any of these repos easily:
git clone kde:<repository name>
You should add the "kde" alias to your [https://techbase.kde.org/Development/Git/Configuration#URL_Renaming Git setup].The code for various Plasma Mobile components can be found on [https://projects.kde.org/projects/playground/mobile git.kde.org].
 
'''todo: add links to phabricator, once set up'''
==Frameworks==
Plasma Mobile is built on top of [https://projects.kde.org/projects/frameworks KDE Frameworks]. You can find download links for the stable releases of these on [http://download.kde.org/stable/frameworks/ download.kde.org] and its API documentation [http://api.kde.org/frameworks-api/frameworks5-apidocs/ here].
 
==Plasma==
Plasma provides components for multi-device workspaces. Plasma desktop provides has been providing a stable, versatile and modular desktop. Plasma Mobile shares many components and all of its underlying architecture with Plasma desktop, but provides a UI and features necessary and useful on mobile devices. The idea is to provide a base platform, that can be augmented with device-specific modules. On a laptop, one would typically install plasma-workspace and plasma-desktop, while on a mobile device, one would install plasma-workspace and plasma-mobile and friends. None of the repositories conflicts with others, so it's possible to provide a system with UIs for multiple formfactors, and decide at runtime, which UI to offer.
You can find the source code tarballs of the stable releases of Plasma on [http://download.kde.org/stable/plasma/ download.kde.org]. A listing of git repositories can be found on [https://quickgit.kde.org/?p=kde-workspace.git quickgit.kde.org].
 
As Plasma Mobile does not have stable release yet, we advise you to pull the code to create tarballs directly from our git repositories' master branches. Relevant repositiories for Plasma Mobile are:
 
==General Mobile Components==
The following git modules are generally useful on mobile devices and provide touch-friendly functionality.
* ''plasma-mobile'': Components generally applicable on mobile devices.
* ''plasma-settings'': Settings application and modules.
* ''plasma-camera'': Camera application.
* ''plasma-angelfish'': Proof-of-concept demo webbrowser for phones.
* ''plasma-samegame'': Small example game, pure QML.
* ''plasma-maliit-framework'': Maliit virtual keyboard integration.
* ''plasma-maliit-plugins'': Maliit virtual keyboard integration.
* ''mtp-server'': Maliit virtual keyboard integration.
 
==Phone Specific==
These additional git modules are useful for smartphones.
* ''plasma-phone-components'': Dialer and Phone shell QtQuick code, application launcher model, etc.
* ''plasma-phone-dev-setup'': Default configs for Plasma Phone
 
==Development Tools==
* ''xbuilder'': Script to set up an SDK.
* ''xutils'': Utilities for the SDK.
* ''plasma-phone-sim'': simulator for development of apps
 
=Building the code=
In order to build Plasma Mobile, please refer to the [https://community.kde.org/Frameworks/Building build instructions].

Latest revision as of 23:08, 5 February 2019

Note

This page is now on [https://docs.plasma-mobile.org/]