plasma-framework/README.md

# Plasma Framework
The plasma framework provides the foundations that can be used to build a primary user interface, from graphical to logical components.

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

## 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.

## 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.

## Links

- Wiki: <http://community.kde.org/Plasma#Plasma_Workspaces_2>
- Mailing list: <https://mail.kde.org/mailman/listinfo/plasma-devel>
- IRC channel: #plasma on Freenode
- Git repository: <https://projects.kde.org/projects/playground/libs/plasma-framework/repository>
Add README.md and yaml files 2013-12-20 20:11:24 +01:00			`# Plasma Framework`
some description 2014-02-10 11:20:50 +01:00			`The plasma framework provides the foundations that can be used to build a primary user interface, from graphical to logical components.`
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:`
			`- A C++ library: libplasma`
			`- Script engines`
			`- QML components`
some description 2014-02-10 11:20:50 +01:00
Refresh doc to use README.md and markdown 2014-04-25 21:05:43 +02:00			`## 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`
some description 2014-02-10 11:20:50 +01:00
Refresh doc to use README.md and markdown 2014-04-25 21:05:43 +02:00			`See @ref libplasma.`

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

			`## 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 README.md and yaml files 2013-12-20 20:11:24 +01:00			`## Links`

README.md: fix link to wiki 2013-12-20 20:36:21 +01:00			`- Wiki: <http://community.kde.org/Plasma#Plasma_Workspaces_2>`
Add README.md and yaml files 2013-12-20 20:11:24 +01:00			`- Mailing list: <https://mail.kde.org/mailman/listinfo/plasma-devel>`
Refresh doc to use README.md and markdown 2014-04-25 21:05:43 +02:00			`- IRC channel: #plasma on Freenode`
Add README.md and yaml files 2013-12-20 20:11:24 +01:00			`- Git repository: <https://projects.kde.org/projects/playground/libs/plasma-framework/repository>`