Permalink
Browse files

prepare the README file for the first public release

  • Loading branch information...
dieterv committed Dec 18, 2010
1 parent 2b01c22 commit 8954b9157ea769c705afe513043bc1efbb43e355
Showing with 44 additions and 48 deletions.
  1. +44 −48 README.rst
View
@@ -1,9 +1,23 @@
-=======
-WARNING
-=======
+=================================
+About the pygtk-installer project
+=================================
-The all-in-one installer should be considered as a proof of concept.
-Please do not use it on production systems just yet!
+The pygtk-installer project provides a set of tools to build the PyGTK
+All-in-one installer and it's various dependencies.
+There are currently versions of the PyGTK All-in-one installer supporting 32 bit
+versions of Python 2.6 and Python 2.7.
+
+Included tools:
+
+- build_glade.sh: a tool that builds glade3 binaries for mswindows with
+ "Python Widgets Support" for each supported Python version.
+- build_bindings.sh: a tool that builds windows installer packages (both .exe
+ and .msi) for pycairo, pygobject, pygtk, pygoocanvas, pygtksourceview and
+ pyrsvg for each supported Python version.
+- build_installer.py: a tool that generates the all-in-one installer bundling
+ the separate .msi installers created by build_bindings.sh, the glade binaries
+ created by build_glade.sh and various GTK+ runtime packages from
+ ftp.gnome.org/pub/GNOME/binaries/win32/.
====================================
Using the PyGTK All-in-one installer
@@ -12,8 +26,8 @@ Using the PyGTK All-in-one installer
The PyGTK All-in-one version number
===================================
-The all-in-one installers' version number does not map directly to the
-pygtk version number. This is a requirement to support windows installer
+The PyGTK All-in-one installers' version number does not map directly to the
+PyGTK version number. This is a requirement to support windows installer
major upgrades. The version number is constructed as follows::
PYGTK_MAJOR.PYGTK_MINOR.INSTALLER_REVISION
@@ -34,27 +48,27 @@ Z.Z is the Python version number the installer supports.
You need to make sure both YY and Z.Z correspond to the version of the Python
interpreter that's installed on your system.
-Migrating from pycairo+pygobject+pygtk packages
+Migrating from PyGTK+PyGObject+PyCairo packages
===============================================
-If you have used some or all of the separate pycaio, pygobject, pygtk, pygoocanvas,
-pygtksourceview2 or pyrsvg packages before, please ensure they are uninstalled
-before you begin with the PyGTK All-in-one installer.
+If you have used some or all of the separate PyGTK, PyGObject, PyGooCanvas,
+PyGtkSourceView2, PyRsvg and PyCairo packages before, please ensure they are
+uninstalled before you begin with the PyGTK All-in-one installer.
The all-in-one installer does not check for their presence and will happily
overwrite files that belong to the separate packages. If you forget to check
for this you risk the following scenario:
- install Python
- - install pycairo, pygtk and pygobject
- - install pygtk all-in-one
- - uninstall pycairo, pygtk and pygobject
+ - install PyCairo, PyGTK and PyGObject
+ - install PyGTK All-in-one
+ - uninstall PyCairo, PyGTK and PyGObject
you now have a *broken* pygtk all-in-one installation
-This would also be a good time to remove the gtk+ runtime you've used with the
-separate pyg* packages and to clean your PATH environment variable.
+This would also be a good time to remove the GTK+ runtime you've used with the
+separate PyG* packages and to clean your PATH environment variable.
-Note that pycaio, pygobject, pygtk, pygoocanvas, pygtksourceview2 and pyrsvg
+Note that the PyCaio, PyGObject, PyGTK, PyGoocanvas, PyGtkSourceView2 and PyRsvg
.exe installers (like any other .exe installer generated by distutils) sometimes
leaves things behind when you uninstall them.
@@ -88,6 +102,9 @@ specified with::
TARGETDIR=R:\pythonX
+Before you set a custom TARGETDIR property, you need to make sure both python.exe
+and pythonw.exe exist in that directory or the installation will fail.
+
Installation for All Users
--------------------------
@@ -102,15 +119,15 @@ ALLUSERS property at all. Hence, a per user installation is the default installa
mode for custom installations. Note that "1" is the only valid value for the
ALLUSERS property!
-You should combine this property with TARGETDIR. Setting ALLUSERS disables the
-automatic Python interpreter detection.
+You need to combine this property with the TARGETDIR property. Setting ALLUSERS
+disables the automatic Python interpreter detection.
Feature Selection
-----------------
The INSTALLLEVEL property determines what features are going to be installed. If
the INSTALLLEVEL property is not set, it's value defaults to 1 which causes a
-basic set of features to be installed (gtk+ runtime, pycairo, pygobject and pygtk)
+basic set of features to be installed (GTK+ runtime, PyGTK, PyGObject and PyCairo)
If you set INSTALLLEVEL to 2 (or any number greater than 2), you instruct the
installer to do a "complete" installation (all features will be installed).
@@ -122,21 +139,21 @@ details.
Other msiexec options
---------------------
-Take note that if the PyGtk All-in-one installer is run with no or a limited
-UI (/q[n|b|r]) the automatic Python installation detection is skipped. In this
+Take note that if the PyGTK All-in-one installer is run with no or a basic
+UI (/q[n|b]) the automatic Python installation detection is skipped. In this
case setting the TARGETDIR property is required. You can also set the ALLUSERS
property if you want a system wide installation.
The PATH environment variable
=============================
The PyGTK All-in-one installer does not require you to fiddle with the PATH
-environment variable. The pygtk version that's installed with the all-in-one
-installer takes care of loading the bundled gtk+ runtime on the PATH environment
+environment variable. The PyGTK version that's installed with the all-in-one
+installer takes care of loading the bundled GTK+ runtime on the PATH environment
variable on interpreter startup. As a consequence simply importing gobject,
-gtk, etc works out of the box. And as an added advantage there is no possible way
-multiple gtk+ runtime versions on your system or user PATH environment variable
-can interfere with pygtk all-in-one.
+gtk, etc works out of the box. As an added advantage there is no possible way
+multiple GTK+ runtime versions on your system or user PATH environment variable
+can interfere with PyGTK All-in-one.
Getting help
============
@@ -159,24 +176,3 @@ If something went wrong when uninstalling, you'll need an unistall log. Execute
the following command from a Command Prompt (cmd.exe)::
%WINDIR%\system32\msiexec.exe -x pygtk-all-in-one-X.X.X.winYY-pyZ.Z.msi /l*vx uninstall.log
-
-=======================
-Installer build scripts
-=======================
-
-The pygtk-installer project provides a set of tools to build the PyGTK
-all-in-one installer and it's various dependencies.
-There are currently versions of the all-in-one installer supporting 32 bit
-versions of Python 2.6 and Python 2.7.
-
-Included tools:
-
-- build_glade.sh: a tool that builds glade3 binaries for mswindows with
- "Python Widgets Support" for each supported Python version.
-- build_bindings.sh: a tool that builds windows installer packages (both .exe
- and .msi) for pycairo, pygobject, pygtk, pygoocanvas, pygtksourceview and
- pyrsvg for each supported Python version.
-- build_installer.py: a tool that generates the all-in-one installer bundling
- the separate .msi installers created by build_bindings.sh, the glade binaries
- created by build_glade.sh and various gtk+ runtime packages from
- ftp.gnome.org/pub/GNOME/binaries/win32/.

0 comments on commit 8954b91

Please sign in to comment.