shift-shell/README.md

<!--
- SPDX-FileCopyrightText: None 
- SPDX-License-Identifier: CC0-1.0
-->

# Plasma Mobile

This repository contains shell components for Plasma Mobile.

### Links
* Project page: https://invent.kde.org/plasma/plasma-mobile
* Documentation: https://invent.kde.org/plasma/plasma-mobile/-/wikis/home
* Issues relating to the shell: https://invent.kde.org/plasma/plasma-mobile/-/issues
* General Plasma Mobile issues: https://invent.kde.org/teams/plasma-mobile/issues/-/issues
* Development channel: https://matrix.to/#/#plasmamobile:matrix.org

### Locations
* [components/mobileshell](mobileshell) - private shell component library (API not guaranteed to be stable!)
* [containments](containments) - shell panels (homescreen, status bar, task panel)
* [homescreens](homescreens) - homescreen packages
* [kcms](kcms) - settings modules
* [look-and-feel](look-and-feel/contents) - Plasma look-and-feel packages (ex. lockscreen, logout, etc.)
* [quicksettings](quicksettings) - quick settings packages for the action drawer

### Test on a development machine

See the [documentation page](https://invent.kde.org/plasma/plasma-mobile/-/wikis/Building-and-Testing-Locally) for more details.

It is recommended to use `kdesrc-build` to build this from source. See [this page](https://community.kde.org/Get_Involved/development) in order to set it up.

Dependencies:
* KDE Frameworks 5 setup (plasma-framework and its dependencies)
* Plasma Nano

To start the phone homescreen in a window, run:
```
QT_QPA_PLATFORM=wayland dbus-run-session kwin_wayland --xwayland "plasmashell -p org.kde.plasma.phoneshell"
```
REUSE compliance, add check to CI, drop unused components 2021-12-23 16:02:41 +00:00			`<!--`
			`- SPDX-FileCopyrightText: None`
			`- SPDX-License-Identifier: CC0-1.0`
			`-->`

Update repo names to plasma-mobile 2022-01-18 16:02:38 +00:00			`# Plasma Mobile`
Initial commit 2014-08-06 08:03:54 +00:00
Update repo names to plasma-mobile 2022-01-18 16:02:38 +00:00			`This repository contains shell components for Plasma Mobile.`
add a brief tutorial on how to start on a desktop tutorial on how to start ofono phonesim as well 2014-11-13 20:29:24 +00:00
Update repo names to plasma-mobile 2022-01-18 16:02:38 +00:00			`### Links`
			`* Project page: https://invent.kde.org/plasma/plasma-mobile`
readme: Add documentation page 2022-02-18 04:34:16 +00:00			`* Documentation: https://invent.kde.org/plasma/plasma-mobile/-/wikis/home`
Update repo names to plasma-mobile 2022-01-18 16:02:38 +00:00			`* Issues relating to the shell: https://invent.kde.org/plasma/plasma-mobile/-/issues`
			`* General Plasma Mobile issues: https://invent.kde.org/teams/plasma-mobile/issues/-/issues`
			`* Development channel: https://matrix.to/#/#plasmamobile:matrix.org`

			`### Locations`
libmobileshell: Move back to QML plugin Move from a C++ library + QML plugin to a QML plugin only for simplicity, since the homescreen switching architecture will be done from Plasma, and so use of the shell library only needs to be from QML. 2022-03-21 14:00:03 +00:00			`* [components/mobileshell](mobileshell) - private shell component library (API not guaranteed to be stable!)`
Update readme 2021-12-23 00:35:46 +00:00			`* [containments](containments) - shell panels (homescreen, status bar, task panel)`
components/mobileshell: Move to libmobileshell library 2022-03-13 20:27:14 +00:00			`* [homescreens](homescreens) - homescreen packages`
quicksettings: Add infrastructure to customize quicksettings order 2022-03-17 03:20:36 +00:00			`* [kcms](kcms) - settings modules`
Update readme 2021-12-23 00:35:46 +00:00			`* [look-and-feel](look-and-feel/contents) - Plasma look-and-feel packages (ex. lockscreen, logout, etc.)`
			`* [quicksettings](quicksettings) - quick settings packages for the action drawer`
Update README.md 2021-05-30 23:57:16 +00:00
Update repo names to plasma-mobile 2022-01-18 16:02:38 +00:00			`### Test on a development machine`
add a brief tutorial on how to start on a desktop tutorial on how to start ofono phonesim as well 2014-11-13 20:29:24 +00:00
Update README.md 2022-02-18 04:34:59 +00:00			`See the [documentation page](https://invent.kde.org/plasma/plasma-mobile/-/wikis/Building-and-Testing-Locally) for more details.`

Update readme 2021-12-23 00:35:46 +00:00			It is recommended to use `kdesrc-build` to build this from source. See [this page](https://community.kde.org/Get_Involved/development) in order to set it up.

add a brief tutorial on how to start on a desktop tutorial on how to start ofono phonesim as well 2014-11-13 20:29:24 +00:00			`Dependencies:`
			`* KDE Frameworks 5 setup (plasma-framework and its dependencies)`
Update readme 2021-12-23 00:35:46 +00:00			`* Plasma Nano`
Update README.md 2015-04-20 12:15:15 +00:00
Move parts of the README to docs.plasma-mobile.org 2019-03-06 15:31:55 +00:00			`To start the phone homescreen in a window, run:`
README: Fix markdown code blocks 2019-01-11 10:58:48 +00:00			```
Fix documentation org.kde.plasma.phone -> org.kde.plasma.phoneshell 2021-02-24 12:35:46 +00:00			`QT_QPA_PLATFORM=wayland dbus-run-session kwin_wayland --xwayland "plasmashell -p org.kde.plasma.phoneshell"`
README: Fix markdown code blocks 2019-01-11 10:58:48 +00:00			```