shift-shell/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

52 lines
2.4 KiB
Markdown
Raw Normal View History

<!--
- SPDX-FileCopyrightText: None
- SPDX-License-Identifier: CC0-1.0
-->
2022-01-18 16:02:38 +00:00
# Plasma Mobile
2014-08-06 08:03:54 +00:00
2022-01-18 16:02:38 +00:00
This repository contains shell components for Plasma Mobile.
* Project page: [plasma-mobile.org](https://plasma-mobile.org)
2022-04-08 23:31:23 +00:00
* Repository: [invent.kde.org/plasma/plasma-mobile](https://invent.kde.org/plasma/plasma-mobile)
* Documentation: [invent.kde.org/plasma/plasma-mobile/-/wikis/home](https://invent.kde.org/plasma/plasma-mobile/-/wikis/home)
* Development channel: [matrix.to/#/#plasmamobile:matrix.org](https://matrix.to/#/#plasmamobile:matrix.org)
### Reporting issues
* How to report issues: [invent.kde.org/plasma/plasma-mobile/-/wikis/Issue-Tracking](https://invent.kde.org/plasma/plasma-mobile/-/wikis/Issue-Tracking)
* Shell issue tracker: [invent.kde.org/plasma/plasma-mobile/-/issues](https://invent.kde.org/plasma/plasma-mobile/-/issues)
* General issue tracker: [https://invent.kde.org/teams/plasma-mobile/issues/-/issues](https://invent.kde.org/teams/plasma-mobile/issues/-/issues)
2022-01-18 16:02:38 +00:00
### Locations
2022-03-21 14:05:56 +00:00
* [components/mobileshell](components/mobileshell) - private shell component library (API not guaranteed to be stable!)
2021-12-23 00:35:46 +00:00
* [containments](containments) - shell panels (homescreen, status bar, task panel)
* [kcms](kcms) - settings modules
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
* [tests](tests) - small runnable snippets that can be used to test parts of the shell without loading all of Plasma
2021-05-30 23:57:16 +00:00
<img src="https://plasma-mobile.org/screenshots/screenshot-2022-04-1.png" width=300px/>
2022-01-18 16:02:38 +00:00
### Test on a development machine
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.
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.
Dependencies:
* KDE Frameworks 5 setup (plasma-framework and its dependencies)
2021-12-23 00:35:46 +00:00
* Plasma Nano
2015-04-20 12:15:15 +00:00
To start the phone homescreen in a window, run:
2019-01-11 10:58:48 +00:00
```
QT_QPA_PLATFORM=wayland dbus-run-session kwin_wayland --xwayland "plasmashell -p org.kde.plasma.phoneshell"
2019-01-11 10:58:48 +00:00
```
---
<img src="https://invent.kde.org/plasma/plasma-mobile/-/wikis/uploads/19a607bb68faa76bbc9f888e33a3aa9a/konqi-calling.png" width=200px>
<br/>
<img src="https://invent.kde.org/plasma/plasma-mobile/-/wikis/uploads/9238173a7cae1d8832d83350eda74f85/developers.png" width=300px>