Commit 8e0107f8 authored by Carl Schwan's avatar Carl Schwan 🚴
Browse files

Start porting user doc

parent 833c3113
......@@ -98,7 +98,7 @@ languages:
weight: 3
- name: Documentation
parent: project
url: https://docs.plasma-mobile.org/
url: /docs
weight: 4
- identifier: community
name: Community
......
---
title: Documentation
weight: 1
---
---
title: Develop For Plasma Mobile
weight: 3
---
We have multiple tutorials regarding how to develop an Plasma Mobile
application, how to debug the telephony features and more at
[develop.kde.org/docs/plasma-mobile](https://develop.kde.org/docs/plasma-mobile).
---
title: Get the source code
weight: 2
---
## Frameworks
Plasma Mobile is built on top of [KDE Frameworks](https://projects.kde.org/projects/frameworks). You can find download links for the stable releases of these on [download.kde.org](http://download.kde.org/stable/frameworks/) and its [API documentation](http://api.kde.org/frameworks/) here.
## Plasma and Plasma Phone Component
Plasma provides components for multi-device workspaces. Plasma desktop
provides 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](http://download.kde.org/stable/plasma/) or check the git
repositories on [invent.kde.org](https://invent.kde.org/plasma).
## Applications
You can find the location of each code repository on the sidebar of
[apps.kde.org](https://apps.kde.org).
## Build the source code
You can find general information on how to build KDE software, on our
[Getting Started page](https://community.kde.org/Get_Involved/development).
We also have a section about [Plasma Mobile](https://community.kde.org/Get_Involved/development#Plasma_Mobile).
## Improving this documentation
Go to [invent.kde.org/websites/plasma-mobile-org](https://invent.kde.org/websites/plasma-mobile-org)
and help us making this documentation better.
---
title: Introduction
weight: 1
---
## Can I use it?
Yes! Plasma Mobile is currently preinstalled on the PinePhone using Manjaro ARM. There are also various other distributions for the PinePhone with Plasma Mobile available.
There is also postmarketOS, a touch-optimized Alpine Linux with support for many more devices, and while it’s in very early stages of development, it offers Plasma Mobile as an available interface for the devices it supports. You can see the list of supported devices here, but given the state of pmOS, your mileage may vary.
The interface is using KWin over Wayland and is now mostly stable, albeit a little rough around the edges in some areas. A subset of the normal KDE Plasma features are available, including widgets and activities, both of which are integrated into the Plasma Mobile UI. This makes it possible to use and develop for Plasma Mobile on your desktop/laptop.
## What can it do?
There are quite a few touch-optimized apps that are now being bundled with the Manjaro-based Plasma Mobile image, allowing a wide range of basic functions. These are mostly built with Kirigami, KDE’s interface framework allowing convergent UIs that work very well in a touch-only environment. You can find a list of these applications on [plasma-mobile.org homepage](https://plasma-mobile.org).
## Where can I find…
The code for various Plasma Mobile components can be found on [invent.kde.org](https://invent.kde.org/plasma-mobile). See [Get the source code](/get-source) for the individual repositories.
You can also ask your questions in the [Plasma Mobile community groups and channels](/join).
......@@ -23,6 +23,10 @@ Manjaro ARM is the Manjaro distribution, but for ARM devices. It's based on Arch
* [Latest Stable (PinePhone)](https://github.com/manjaro-pinephone/plasma-mobile/releases)
* [Developer builds (Pinephone)](https://github.com/manjaro-pinephone/plasma-mobile-dev/releases)
#### Installation
For the PinePhone, you can find generic information on [Pine64 wiki](https://wiki.pine64.org/index.php/PinePhone_Installation_Instructions).
### openSUSE
![](/img/openSUSE.svg)
......@@ -33,6 +37,10 @@ openSUSE, formerly SUSE Linux and SuSE Linux Professional, is a Linux distributi
* [PinePhone](https://download.opensuse.org/repositories/devel:/ARM:/Factory:/Contrib:/PinePhone/images/openSUSE-Tumbleweed-ARM-PLAMO-pinephone.aarch64.raw.xz)
#### Installation
For the PinePhone, you can find generic information on [Pine64 wiki](https://wiki.pine64.org/index.php/PinePhone_Installation_Instructions).
### postmarketOS
![](/img/pmOS.svg)
......
......@@ -24,5 +24,16 @@ adapting:
other: Adapting to your needs
based:
other: Being based on the most flexible desktop in the world means you can truly make your phone your own. Add and modify widgets, change colour schemes, fonts, and much, much more.
Applications:
home.applications:
other: Applications
home.applications.description:
other: Plasma Mobile are developed with [Kirigami](https://develop.kde.org/frameworks/kirigami) but applications developed for other Linux operating system are generally compatible.
home.whatis:
other: What is Plasma Mobile?
home.whatis.description:
other: Plasma Mobile offers a free (as in freedom and beer), user-friendly, privacy-enabling and customizable platform for mobile devices. It is shipped by different distributions (ex. postmarketOS, Manjaro, openSUSE), and can run on the devices that are supported by the distribution. Most of the testing is done on the PinePhone, as it is easier for developers to obtain and develop on. However, depending on your distribution, you may be able to install it on your device!
home.why:
other: Why?
home.why.description:
other: The most common offerings on mobile devices lack openness and trust. In a world of walled gardens, we want to create a platform that respects and protects the user’s privacy to the fullest. We want to provide a fully open base which others can help develop and use for themselves, or in their products.
......@@ -15,7 +15,19 @@
<section class="applications-section">
<div class="container">
<h2 class="text-center">{{ i18n "Applications" }}</h2>
<h2 class="text-center">{{ i18n "home.whatis" }}</h2>
<p class="mx-auto" style="width: 800px">{{ i18n "home.whatis.description" }}</p>
<h2 class="text-center">{{ i18n "home.why" }}</h2>
<p class="mx-auto" style="width: 800px">{{ i18n "home.why.description" }}</p>
<p class="d-flex justify-content-center">
<a href="/get/" class="btn btn-primary mx-2">{{ i18n "install" }}</a>
<a href="/findyourway/" class="btn btn-primary mx-2">{{ i18n "contribute" }}</a>
</p>
<h2 class="text-center">{{ i18n "home.applications" }}</h2>
<p class="mx-auto" style="width: 800px">{{ i18n "home.applications.description" | markdownify }}</p>
<div class="applications row align-items-stretch">
{{ range $.Site.Data.applications }}
{{ $app := getJSON .url }}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment