aboutsummaryrefslogtreecommitdiffhomepage
path: root/qt/README
diff options
context:
space:
mode:
authornyamatongwe <unknown>2012-05-17 12:46:29 +1000
committernyamatongwe <unknown>2012-05-17 12:46:29 +1000
commitbf8b35542c4be4b8eebb71ca2ad518da2e12b850 (patch)
treeeab094df23f84c33c7ed03f3412a63a060d31eac /qt/README
parent29c92749f25f24795ecd9fec2b6705129ebbd654 (diff)
downloadscintilla-mirror-bf8b35542c4be4b8eebb71ca2ad518da2e12b850.tar.gz
Qt platform layer added. Based on an implementation from Jason Haslam
at Scientific Toolworks, Inc. with additions performed for Wingware.
Diffstat (limited to 'qt/README')
-rw-r--r--qt/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/qt/README b/qt/README
new file mode 100644
index 000000000..a39008b38
--- /dev/null
+++ b/qt/README
@@ -0,0 +1,36 @@
+README for building of Scintilla on Qt
+
+There are three different Scintilla libraries that can be produced:
+
+ ScintillaEditBase
+A basic widget callable from C++ which is small and can be used just as is
+or with higher level functionality added.
+
+ ScintillaEdit
+A more complete C++ widget with a method for every Scintilla API and a
+secondary API allowing direct access to document objects.
+
+ ScintillaEditPy
+A Python callable version of ScintillaEdit using the PySide bindings.
+
+ Building a library
+
+ScintillaEditBase can be built without performing any generation steps.
+The ScintillaEditBase/ScintillaEditBase.pro project can be loaded into
+Qt Creator and the "Build All" command performed.
+Alternatively, run "qmake" to build make files and then use the platform
+make to build. Most commonly, use "make" on Unix and "nmake"
+on Windows.
+
+ScintillaEdit requires a generation command be run first. From the
+ScintillaEdit directory:
+
+python WidgetGen.py
+
+After the generation command has run, the ScintillaEdit.h and
+ScintillaEdit.cpp files will have been populated with the Scintilla API
+methods.
+To build, use Qt Creator or qmake and make as for ScintillaEditBase.
+
+ScintillaEditPy is more complex and instructions are found in
+ScintillaEditPy/README.