aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Merry <alex.merry@kde.org>2014-04-10 15:45:41 +0100
committerAlex Merry <alex.merry@kde.org>2014-04-11 10:27:23 +0100
commitbc157c1bb768c5b8c7a72c8f6ef29ba313c465b0 (patch)
treed04a6c3e747be723226608320c5ff80327223d38 /README.md
parentc038ab7498fb8715ede62d18fac6eee4c1798668 (diff)
downloadkconfig-bc157c1bb768c5b8c7a72c8f6ef29ba313c465b0.tar.gz
kconfig-bc157c1bb768c5b8c7a72c8f6ef29ba313c465b0.tar.bz2
Rewrite kiosk documentation
A lot of kiosk stuff is actually in other frameworks, from the point of view of applications, but KConfig provides the core functionality. Make the docs here describe KConfig's role, rather than KIO's or KXMLGui's. REVIEW: 117486
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.md b/README.md
index 87cb2a05..3e6f6fd6 100644
--- a/README.md
+++ b/README.md
@@ -9,10 +9,13 @@ KConfigCore and KConfigGui.
KConfigCore provides access to the configuration files themselves. It features:
-- centralized definition: define your configuration in an XML file and use
-`kconfig_compiler` to generate classes to read and write configuration entries.
-
-- lock-down (kiosk) support.
+- Code generation: describe your configuration in an XML file, and use
+ `kconfig_compiler to generate classes that read and write configuration
+ entries.
+- Cascading configuration files (global settings overridden by local settings).
+- Optional shell expansion support (see [docs/options.md](@ref options)).
+- The ability to lock down configuration options (see
+ [docs/options.md](@ref options)).
KConfigGui provides a way to hook widgets to the configuration so that they are
automatically initialized from the configuration and automatically propagate
@@ -22,5 +25,5 @@ their changes to their respective configuration files.
- Home page: <https://projects.kde.org/projects/frameworks/kconfig>
- Mailing list: <https://mail.kde.org/mailman/listinfo/kde-frameworks-devel>
-- IRC channel: #kde-devel on Freenode
+- IRC channel: \#kde-devel on Freenode
- Git repository: <https://projects.kde.org/projects/frameworks/kconfig/repository>