summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README64
1 files changed, 64 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..1af7d9f
--- /dev/null
+++ b/README
@@ -0,0 +1,64 @@
+ PyQt - Python Bindings for the Qt Toolkit
+
+
+INTRODUCTION
+
+These are the Python bindings for Qt. You must also have the SIP Python
+bindings generator installed.
+
+The homepage is http://www.riverbankcomputing.co.uk/pyqt/.
+
+The homepage of SIP is http://www.riverbankcomputing.co.uk/sip/.
+
+
+COMMERCIAL VERSION
+
+If you have the Commercial version of PyQt then you should also have a
+license file that you downloaded separately. The license file must be copied
+to the "sip" directory before starting to build PyQt.
+
+
+INSTALLATION
+
+Check for any other README files in this directory that relate to your
+particular platform. Feel free to contribute a README for your platform or to
+provide updates to any existing documentation.
+
+The first step is to configure PyQt by running the following command.
+
+ python configure.py
+
+This assumes that the correct Python interpreter is on your path. Something
+like the following may be appropriate on Windows.
+
+ c:\python23\python configure.py
+
+If you have multiple versions of Python installed then make sure you use the
+interpreter for which you wish to generate bindings for.
+
+The configure.py script takes many options. Use the "-h" command line option
+to display a full list of the available options.
+
+The next step is to build PyQt using your platform's make command.
+
+ make
+
+The final step is to install PyQt by running the following command. (Depending
+on your system you may require root or administrator privileges.)
+
+ make install
+
+
+THE REST OF THE DISTRIBUTION
+
+The "examples2" and "examples3" directories contain some examples (for Qt v2.x
+and Qt v3.x respectively) of Python scripts, including versions of the standard
+Qt tutorials and examples.
+
+The "doc" directory contains SGML and HTML documentation for the bindings.
+This documentation includes a section describing the differences visible to
+the Python programmer between this and the previous version - please read it.
+
+
+Phil Thompson
+phil@riverbankcomputing.co.uk