plasma-framework/README.md

# Plasma Framework

Foundational libraries, components, and tools of the Plasma workspaces

## Introduction
The plasma framework provides the following:
- QML components
- A C++ library: libplasma
- Script engines

## QML components
### org.kde.plasma.core

Bindings for libplasma functionality, such as DataEngine and FrameSvg, see @ref core.

### org.kde.plasma.components
Graphical components for common items such as buttons, lineedits, tabbars and so on. Compatible subset of the MeeGo components used on the N9, see @ref plasmacomponents.

### org.kde.plasma.extras
Extra graphical components that extend org.kde.plasma.components but are not in the standard api, see @ref plasmaextracomponents.

### org.kde.plasma.plasmoid
Attached properties for manipulating the current applet or containment, see @ref libplasmaquick

## libplasma
This C++ library provides:
- rendering of SVG themes
- loading of files from a certain filesystem structure: packages
- data access through data engines
- loading of the plugin structure of the workspace: containments and applets

See @ref libplasma.

## Script engines
Provides support to create applets or containments in various scripting languages.
Add README.md and yaml files 2013-12-20 20:11:24 +01:00			`# Plasma Framework`
Add/update first line of README.md to be a short description, useful for inqlude 2015-07-27 19:26:31 +02:00
			`Foundational libraries, components, and tools of the Plasma workspaces`
Add README.md and yaml files 2013-12-20 20:11:24 +01:00
			`## Introduction`
Refresh doc to use README.md and markdown 2014-04-25 21:05:43 +02:00			`The plasma framework provides the following:`
Put QML Components at the top They're more useful than the C++ lib which will be used by only shell writers. The QML bits will be used by all applet writers. Change-Id: Ib6d1bef0676fdac054db52e876cf9a89056e591b 2014-09-12 14:00:32 +02:00			`- QML components`
Refresh doc to use README.md and markdown 2014-04-25 21:05:43 +02:00			`- A C++ library: libplasma`
			`- Script engines`

			`## QML components`
			`### org.kde.plasma.core`

			`Bindings for libplasma functionality, such as DataEngine and FrameSvg, see @ref core.`

			`### org.kde.plasma.components`
			`Graphical components for common items such as buttons, lineedits, tabbars and so on. Compatible subset of the MeeGo components used on the N9, see @ref plasmacomponents.`

			`### org.kde.plasma.extras`
			`Extra graphical components that extend org.kde.plasma.components but are not in the standard api, see @ref plasmaextracomponents.`

Add link to appletinterface documentation Change-Id: I3a0bce2ec7ecc18c2efe9d5759eabd2c11a0acba 2014-09-12 13:53:00 +02:00			`### org.kde.plasma.plasmoid`
Put QML Components at the top They're more useful than the C++ lib which will be used by only shell writers. The QML bits will be used by all applet writers. Change-Id: Ib6d1bef0676fdac054db52e876cf9a89056e591b 2014-09-12 14:00:32 +02:00			`Attached properties for manipulating the current applet or containment, see @ref libplasmaquick`

			`## libplasma`
			`This C++ library provides:`
			`- rendering of SVG themes`
			`- loading of files from a certain filesystem structure: packages`
			`- data access through data engines`
			`- loading of the plugin structure of the workspace: containments and applets`

			`See @ref libplasma.`

			`## Script engines`
			`Provides support to create applets or containments in various scripting languages.`