add README

Signed-off-by: Ivailo Monev <xakepa10@gmail.com>

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..cc92c46
--- /dev/null
+++ b/README
@@ -0,0 +1,41 @@
+Katie is continuation of the Qt4 C++ toolkit with the goal to keep it alive,
+clean it up, fix some bugs and backport some features from Qt5. It is based
+on the latest Git revision of Qt v4.8.
+
+There are several things you should be aware before considering Katie:
+
+ - some components and tools have been removed:
+  - QMake, Designer, D-Bus viewer, Linguist, Assistant, checksdk, macdeployqt,
+    pixeltool, qconfig, qdoc, qev, qvfb, runonphone and other non-essential
+  - Qt3Support, QtWebKit and ActiveQt
+
+ - some things have changed:
+  - QMake build system replaced with CMake
+  - QStyleOption*V{2,3,4} classes have been merged
+  - QKeyEventEx and QKeyEvent classes have been merged
+  - OpenSSL and D-Bus are not a runtime dependencies, they must be linked to
+    during build
+  - QtUiTools is build as shared library by default
+  - Phonon has been updated to 4.8.51
+  - Phonon backends (GStreamer, DS9, MMF, QT7, WaveOut) replaced with VLC
+  - removed non-open source DB2, OCI and TDS database drivers
+  - OpenVG is no longer supported graphics output
+  - updated bundled Harfbuzz from upstream (not Harfbuzz-NG)
+  - Symbian is no longer supported platform
+  - QML debugger and inspector have been removed, potentially dangerous
+
+ - some additions have been made: 
+  - JSON classes and types
+  - command line parser
+  - standard directories handler
+
+Bugs fixed in Katie, some of which in Qt5 too:
+QTBUG-23502, QTBUG-37115, QTBUG-15052, QTBUG-23522, QTBUG-6139, QTBUG-26889,
+QTBUG-21548, QTBUG-6133, QTBUG-18188, QTBUG-36767, QTBUG-35387, QTBUG-37035,
+QTBUG-28321, QTBUG-21993, QTBUG-26590, QTBUG-2124, QTBUG-20482,
+QTBUG-41361, QTBUG-40153, QTBUG-35479
+
+Unless you use QMake and QDoc porting to Katie or even supporting it along with
+Qt4 in the same code-base is trivial and requires only a minor changes because
+Katie is mostly compatible with Qt4. Should you enouncter a problem please
+report it at https://github.com/fluxer/katie/issues.