kf5: added a directory with my configuration of KDE Frameworks.

1 files changed, 22 insertions, 0 deletions

diff --git a/kf5/README.md b/kf5/README.md
new file mode 100644
index 0000000..f8b0b8f
--- /dev/null
+++ b/kf5/README.md
@@ -0,0 +1,22 @@
+# KDE Frameworks
+
+This directory has all the files that I use to compile KDE Frameworks. Note,
+that I don't guarantee that all the modules are nicely compiling, I've just
+checked the ones I need to compile Kate. Moreover, the KTextEditor library is
+not included in the list of modules to be compiled. This is because it's the
+only library from Frameworks that I contribute and, therefore, I want to keep
+it separately. I will remove this directory when the KDE Frameworks is stable
+and all the KDE apps are ported to Frameworks.
+
+In order to compile everything, perform the following commands in the directory
+where all the KDE Frameworks sources should go:
+
+    $ source kf5.sh
+    $ ./kf5-build.sh
+
+This configuration assumes that:
+
+  * The KF5 libraries will be installed at $HOME/kf5.
+  * You have Qt 5 installed at /opt/qt5.
+
+Happy hacking!