aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAurélien Gâteau <agateau@kde.org>2013-12-20 20:11:24 +0100
committerAurélien Gâteau <agateau@kde.org>2013-12-20 20:11:24 +0100
commit43d14576bd430968f5ec155323c3395d94753a18 (patch)
treee28c3b9bd8ce0222e92f47dc87001b725fd23f6b /README.md
parent873a30141491b4188858eb96bb0981e98d50615d (diff)
downloadkconfig-43d14576bd430968f5ec155323c3395d94753a18.tar.gz
kconfig-43d14576bd430968f5ec155323c3395d94753a18.tar.bz2
Add README.md and yaml files
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..14c47646
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# KConfig
+
+## Introduction
+
+KConfig provides an advanced configuration system. It is made of two parts:
+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.
+
+KConfigGui provides a way to hook widgets to the configuration so that they are
+automatically initialized from the configuration and automatically propagate
+their changes to their respective configuration files.
+
+## Links
+
+- Mailing list: <https://mail.kde.org/mailman/listinfo/kde-frameworks-devel>
+- IRC channel: #kde-devel on Freenode
+- Git repository: <https://projects.kde.org/projects/frameworks/kconfig/repository>