From 58133666de42974b013a39333b5dd72931885a07 Mon Sep 17 00:00:00 2001 From: Devin Lin Date: Wed, 22 Dec 2021 19:35:46 -0500 Subject: [PATCH] Update readme --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cdce00d1..16953e2c 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,12 @@ UI components for Plasma Mobile. -Contains components such as: -* Shell panels ([task panel](containments/taskpanel), and [top panel](containments/panel)) -* [Homescreen](containments/homescreen) -* [Logout menu](look-and-feel/contents/logout) -* [Lockscreen theme](look-and-feel/contents/lockscreen) -* [Search applet](applets/krunner) +Locations: +* [applets](applets) - plasmoids +* [components/mobileshell](components/mobileshell) - shell component library +* [containments](containments) - shell panels (homescreen, status bar, task panel) +* [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 ## Links * Project page: https://invent.kde.org/plasma/plasma-phone-components @@ -17,8 +17,11 @@ Contains components such as: ## Test on a development machine +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: ```