Plasma/Mobile/Code: Difference between revisions

From KDE Community Wiki
< Plasma‎ | Mobile
No edit summary
(12 intermediate revisions by 4 users not shown)
Line 3: Line 3:
You can check out any of these repos easily:
You can check out any of these repos easily:
  git clone kde:<repository name>
  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].
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://phabricator.kde.org/diffusion/query/H_KxUC6zq6ET/ the git repository] (but please read below for more details).


'''todo: add links to phabricator, once set up'''
==Frameworks==
==KDE 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 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 Workspaces==
==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. 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://projects.kde.org/projects/kde/workspace projects.kde.org].  
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]. Git repositories can be browsed on [https://cgit.kde.org/ cgit.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:
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==
==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-mobile'': Components generally applicable on mobile devices.
* ''plasma-settings'': Settings application and modules.
* ''plasma-settings'': Settings application and modules.
Line 20: Line 21:
* ''plasma-angelfish'': Proof-of-concept demo webbrowser for phones.
* ''plasma-angelfish'': Proof-of-concept demo webbrowser for phones.
* ''plasma-samegame'': Small example game, pure QML.
* ''plasma-samegame'': Small example game, pure QML.
* ''plasma-maliit-frameworks'': Maliit virtual keyboard integration.
* ''plasma-maliit-framework'': Maliit virtual keyboard integration.
* ''plasma-maliit-plugin'': Maliit virtual keyboard integration.
* ''plasma-maliit-plugins'': Maliit virtual keyboard integration.
* ''mtp-server'': Maliit virtual keyboard integration.
* ''mtp-server'': Fork of Ubuntu's MTP server


==Phone Specific==
==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-components'': Dialer and Phone shell QtQuick code, application launcher model, etc.
* ''plasma-phone-dev-setup'': Default configs for Plasma Phone


==Development Tools==
==Development Tools==
* ''xbuilder'': Script to set up an SDK.
* ''xbuilder'': Script to set up an SDK.
* ''xutils'': Utilities for the 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].

Revision as of 22:16, 29 June 2017

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 Git setup. The code for various Plasma Mobile components can be found on the git repository (but please read below for more details).

Frameworks

Plasma Mobile is built on top of KDE Frameworks. You can find download links for the stable releases of these on download.kde.org and its API documentation 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 download.kde.org. Git repositories can be browsed on cgit.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: Fork of Ubuntu's MTP server

Phone Specific

These additional git modules are useful for smartphones.

  • plasma-phone-components: Dialer and Phone shell QtQuick code, application launcher model, etc.

Development Tools

  • xbuilder: Script to set up an SDK.
  • xutils: Utilities for the SDK.

Building the code

In order to build Plasma Mobile, please refer to the build instructions.