aboutsummaryrefslogtreecommitdiff
path: root/tests/KDEPackageAppTemplatesTest/qml-plasmoid/README
diff options
context:
space:
mode:
Diffstat (limited to 'tests/KDEPackageAppTemplatesTest/qml-plasmoid/README')
-rw-r--r--tests/KDEPackageAppTemplatesTest/qml-plasmoid/README32
1 files changed, 32 insertions, 0 deletions
diff --git a/tests/KDEPackageAppTemplatesTest/qml-plasmoid/README b/tests/KDEPackageAppTemplatesTest/qml-plasmoid/README
new file mode 100644
index 00000000..6814263d
--- /dev/null
+++ b/tests/KDEPackageAppTemplatesTest/qml-plasmoid/README
@@ -0,0 +1,32 @@
+Plasma Applet Template
+----------------------
+
+-- Build instructions --
+
+cd /where/your/applet/is/generated
+mkdir build
+cd build
+cmake -DCMAKE_INSTALL_PREFIX=MYPREFIX ..
+make
+make install
+
+(MYPREFIX is where you install your Plasma setup, replace it accordingly)
+
+Restart plasma to load the applet
+(in a terminal type:
+kquitapp plasmashell
+and then
+plasmashell)
+
+or view it with
+plasmoidviewer -a YourAppletName
+
+-- Tutorials and resources --
+The explanation of the template
+http://techbase.kde.org/index.php?title=Development/Tutorials/Plasma/GettingStarted
+
+Plasma techbase pages
+http://techbase.kde.org/Projects/Plasma
+
+Plasma QML API explained
+http://techbase.kde.org/Development/Tutorials/Plasma/QML/API