updated documentation

git-svn-id: http://svn.code.sf.net/p/pythonqt/code/trunk@287 ea8d5007-eb21-0410-b261-ccb3ea6e24a9

Author: florianlink

src/PythonQtDoc.h

@@ -54,10 +54,10 @@
  \section Introduction
 
  \b PythonQt is a dynamic <a href="http://www.python.org" target="_blank"> 
-Python</a> binding for the <a href="http://qt.nokia.com" target="_blank"> 
+Python</a> binding for the <a href="http://qt-project.org/" target="_blank"> 
 Qt framework</a>.
  It offers an easy way to embed the Python scripting language into
- your C++ Qt applications. It makes heavy use of the QMetaObject system and thus requires Qt 4.x.
+ your C++ Qt applications.
 
  The focus of PythonQt is on embedding Python into an existing C++ application, not on writing the whole
  application completely in Python. If you want to write your whole application in Python,
@@ -78,7 +78,7 @@ Qt framework</a>.
  - \ref Examples
 
  \page Features Features
-
+ 
  \section Builtin Built-in Features
 
  The following are the built-in features of the PythonQt library:
@@ -124,6 +124,17 @@ Qt framework</a>.
  - Polymorphic downcasting on QEvent, QGraphicsItem, QStyleOption, ...
  - Multiple inheritance support (e.g., QGraphicsTextItem is a QObject AND a QGraphicsItem, PythonQt will handle this well)
 
+ \section Supported Supported Versions
+
+ PythonQt supports:
+ - Python 2 (>= Python 2.6)
+ - Python 3 (>= Python 3.3)
+ - Qt 4.x (Qt 4.7 and Qt 4.8 recommended)
+ - Qt 5.x (Tested with Qt 5.0 and 5.3)
+ 
+ The Qt5 support does not yet include Qt modules that have been introduced with Qt5. The new QtWidgets module is wrapped as part of QtGui.
+ This allows to run scripts that were written with the Qt4 binding on a Qt5 PythonQt without porting.
+
  \section Comparison Comparison with PyQt/PySide
 
  - PythonQt is not as pythonic as PyQt in many details (e.g. buffer protocol, pickling, translation support, ...) and it is mainly thought for embedding and intercommunication between Qt/Cpp and Python
@@ -133,11 +144,9 @@ Qt framework</a>.
  - QObject.emit to emit Qt signals from Python is not yet implemented but PythonQt allows to just emit a signal by calling it like a normal slot
  - PythonQt does not (yet) offer to add new signals to Python/C++ objects and it does not yet support the newstyle PyQt signals (so you need to connect via C++ string signatures)
  - Ownership of objects is a bit different in PythonQt, currently Python classes derived from a C++ class need to be manually referenced in Python to not get deleted too early (this will be fixed in a future version)
- - QStrings are always converted to unicode Python objects, QByteArray always stays a QByteArray and can be converted using str()
+ - QStrings are always converted to unicode Python objects, QByteArray always stays a QByteArray and can be converted using str() or QByteArray.data()
  - There are many details in the generated wrappers that could need some polishing, e.g., methods that use pointer arguments for additional return values could return a results tuple.
  - Not all types of QList/QVector/QHash templates are supported, some Qt methods use those as arguments/return values (but you can add your own handlers to handle them if you need them).
- - Probably there are lots of details that differ, I do not know PyQt that well to list them all.
- - In the long run, PythonQt will consider using/extending PySide with the features of PythonQt to get rid of its own generator and typesystem files, alternatively the KDE Smoke generator might be used in the future (this has not yet been decided, the current PythonQt generator works well and there is no hurry to switch). 
 
  \page Download Download
 
@@ -149,7 +158,7 @@ Qt framework</a>.
  You can also browse the source code online via ViewVC: http://pythonqt.svn.sourceforge.net/viewvc/pythonqt/trunk/
 
  \note We do not offer prebuilt binaries, since there are so many possible combinations of
- platforms (Windows/Linux/MacOs), architectures (32/64 bit) and Python versions.
+ platforms (Windows/Linux/MacOs), architectures (32/64 bit) and Qt / Python versions.
 
  \page License License
   
@@ -414,17 +423,18 @@ yourCpp = None
 
  \page Building Building
 
- PythonQt requires at least Qt 4.6.1 (for earlier Qt versions, you will need to run the pythonqt_gerenator, Qt 4.3 is the  absolute minimum) and Python 2.5.x or 2.6.x on Windows, Linux and MacOS X. It has not yet been tested with Python 3.x, but it should only require minor changes.
+ PythonQt requires at least Qt 4.6.1 (for earlier Qt versions, you will need to run the pythonqt_generator, Qt 4.3 is the absolute minimum) and Python 2.6.x/2.7.x or Python 3.3 (or higher).
  To compile PythonQt, you will need a python developer installation which includes Python's header files and
 the python2x.[lib | dll | so | dynlib].
+ The recommended way to build PythonQt is to use the QMake-based *.pro file.
  The build scripts a currently set to use Python 2.6.
  You may need to tweak the \b build/python.prf file to set the correct Python includes and libs on your system.
-
+ 
  \subsection Windows
 
  On Windows, the (non-source) Python Windows installer can be used.
- Make sure that you use the same compiler, the current Python distribution is built
- with Visual Studio 2003. If you want to use another compiler, you will need to build
+ Make sure that you use the same compiler as the one that your Python distribution is built with.
+ If you want to use another compiler, you will need to build
  Python yourself, using your compiler.
 
  To build PythonQt, you need to set the environment variable \b PYTHON_PATH to point to the root
@@ -459,6 +469,11 @@ the python2x.[lib | dll | so | dynlib].
 
  The tests and examples are located in PythonQt/lib.
 
+ When using a Python distribution, the debug build typically does not work because the
+ pythonxx_d.lib/.dll are not provided. You can tweak linking of the debug build to the release
+ Python version, but this typically requires patching pyconfig.h and removing Py_DEBUG and linker pragmas
+ (google for it!).
+ 
  \subsection Linux
 
  On Linux, you need to install a Python-dev package.