Revision as of 17:44, 19 May 2018

Plasma Mobile Developer Guide

Under Construction
This is a new page, currently under construction!

The development environment needed depends on the specific area of Plasma Mobile you want to contribute. There are three kinds of development environment:

General Linux-based development environment
Plasma Mobile emulated environment
Mobile device running plasma mobile

For most tasks you will not need an actual mobile device running Plasma Mobile. Moreover, although you may contribute to Plasma Mobile using any kind of linux-based development environment , we strongly suggest to use the Plasma Mobile pre compiled image, since such an environment will make the development much easier and facilitate the testing of your work on a machine that emulates a mobile device.

Plasma Mobile emulated environment

Get the Plasma Moible precompiled image

At first, you have to download the precompiled ISO image. TODO: Add link

Run the virtual machine

To use the precompiled ISO, QEMU should be installed. QEMU is a free and open-source hosted hypervisor that performs hardware virtualization. In Ubuntu-based distributions (e.g. KDE neon), just execute:

sudo apt install qemu-utils qemu-system-x86

Mobile device running plasma mobile

Currently, you may run Plasma Mobile on an actual mobile device, either by installing postmarketOs or using Halium as hardware adaption layer.

Using postmarketOS

PostmarketOS is a touch-optimized, pre-configured Alpine Linux-based distribution. Currently, postmarketOS has been ported to many devices. Ensure that your device belongs to the relative list and proceed to installation, following the installation instructions provided by postmarketOS team. When asked during installation, just select “plasma-mobile” as the user interface:

Available user interfaces (5):
* none: No graphical environment
* hildon: (X11) Lightweight GTK+2 UI (optimized for single-touch touchscreens)
* luna: (Wayland) webOS UI, ported from the LuneOS project (Not working yet)
* plasma-mobile: (Wayland) Mobile variant of KDE Plasma, optimized for touchscreen
* weston: (Wayland) Reference compositor (demo, not a phone interface)
* xfce4: (X11) Lightweight GTK+2 desktop (stylus recommended)
User interface [weston]: plasma-mobile

Using Halium

Halium provides the minimal android layer that allows a non-Android graphical environment to interact with the underlying Android kernel and access the hardware. Currently Halium has been ported to many devices. The Plasma Mobile team provides a Neon-based rootfs which can be used along with the Halium builds. This image is based on the dev-unstable branch of KDE Neon, and always ships the latest versions of KDE frameworks, kwin and Plasma Mobile.

To run Plasma Mobile using Halium as hardware adaption layer:

Ensure that a source manifest manifest exist for your device.
Download the Neon-based rootfs image
Get the source manifest for your device
Follow the Halium documention detailed instructions to install Halium

@@ Line 15: / Line 15: @@
 === Run the virtual machine ===
-To use the precompiled ISO, QEMU should be installed. QEMU is a free and open-source hosted hypervisor that performs hardware virtualization. In ubuntu based distributions (e.g. KDE neon) , just execute:
+To use the precompiled ISO, QEMU should be installed. QEMU is a free and open-source hosted hypervisor that performs hardware virtualization. In Ubuntu-based distributions (e.g. KDE neon), just execute:
 {{Input|1=<nowiki>
 sudo apt install qemu-utils qemu-system-x86</nowiki>}}
@@ Line 22: / Line 22: @@
 Currently, you may run Plasma Mobile on an actual mobile device, either by installing postmarketOs or using Halium as hardware adaption layer.
-* Using postmarketOS
-* Installing Halium and a KDE neon-based rootfs
 === Using postmarketOS ===
-[https://postmarketos.org/ PostmarketOS] is touch-optimized, pre-configured Alpine Linux-based distribution which offers Plasma Mobile as one choice of several available user interfaces. There is a list of [https://wiki.postmarketos.org/wiki/Devices devices] that can run postmarketOS, and you can find [https://wiki.postmarketos.org/wiki/Installation_guide instructions] on installing postmarketOS on your device at their wiki page.
+[https://postmarketos.org/ PostmarketOS] is a touch-optimized, pre-configured Alpine Linux-based distribution. Currently, postmarketOS has been ported to many devices. Ensure that your device belongs to the relative [https://wiki.postmarketos.org/wiki/Devices list] and proceed to installation, following the [https://wiki.postmarketos.org/wiki/Installation_guide  installation instructions] provided by postmarketOS team. When asked during installation, just select “plasma-mobile” as the user interface:
-When you follow the instructions to install postmarketOS, remember to select “plasma-mobile” as the user interface when asked:
 {{Input|1=<nowiki>
 Available user interfaces (5):
@@ Line 39: / Line 35: @@
 </nowiki>}}
 === Using Halium ===
-[https://halium.org/ Halium] provides the minimal android layer that allows a non-Android graphical environment to interact with the underlying Android kernel and access the hardware. The Plasma Mobile team provides a Neon-based rootfs which can be used along with the Halium builds.
+[https://halium.org/ Halium] provides the minimal android layer that allows a non-Android graphical environment to interact with the underlying Android kernel and access the hardware. Currently Halium has been ported to many devices. The Plasma Mobile team provides a Neon-based rootfs which can be used along with the Halium builds. This image is based on the dev-unstable branch of KDE Neon, and always ships the latest versions of KDE frameworks, kwin and Plasma Mobile.
-To run Plasma Mobile using Halium as hardware adaption layer, download the official [https://www.plasma-mobile.org/get/ image], based on KDE Neon. This image is based on the dev-unstable branch of KDE Neon, and always ships the latest versions of KDE frameworks, kwin and Plasma Mobile.
+To run Plasma Mobile using Halium as hardware adaption layer:
-Currently Halium has been ported to many devices.Just get the source [https://github.com/halium/projectmanagement/issues?q=is%3Aissue+is%3Aopen+label%3APort manifest] of your device and build your own images. Check Halium [http://docs.halium.org/en/latest/ documention] for detailed instructions about building and installing Halium .
+* Ensure that a source manifest [https://github.com/halium/projectmanagement/issues?q=is%3Aissue+is%3Aopen+label%3APort manifest] exist for your device.
+* Download the Neon-based rootfs [https://www.plasma-mobile.org/get/ image]
+* Get the source [https://github.com/halium/projectmanagement/issues?q=is%3Aissue+is%3Aopen+label%3APort manifest] for your device
+* Follow the Halium documention [http://docs.halium.org/en/latest/ detailed instructions] to install Halium