From 6d8bbfaa5e226e0f488b9b4aed0dd387f80c044d Mon Sep 17 00:00:00 2001
From: Roman Lacko <backup.rlacko@gmail.com>
Date: Fri, 8 Jun 2012 10:24:06 +0200
Subject: update doc

---
 README.txt | 149 +++++++++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 105 insertions(+), 44 deletions(-)

(limited to 'README.txt')

diff --git a/README.txt b/README.txt
index 03ec60a6c..d444b035a 100644
--- a/README.txt
+++ b/README.txt
@@ -18,27 +18,30 @@ Compatibility
 
 PySide requires Python 2.6 or later and Qt 4.6 or better.
 
-Installing PySide on a UNIX System (Ubuntu 12.04 LTS)
-=====================================================
+Installing PySide from source on a Windows System
+=================================================
 
-#. Install Python 2.7 header files and a static library:
-    
-   .. code-block:: text
+Installing prerequisities
+-------------------------
 
-      $ sudo apt-get install python2.7-dev
-   
-#. Install Qt 4.8 libraries:
-    
-   .. code-block:: text
+#. Install `Python 2.7
+   <http://python.org/download/releases/2.7.3/>`_.
 
-      $ sudo apt-get install qt-sdk
-   
-#. Install cmake:
-    
-   .. code-block:: text
+#. Install `Qt 4.8 libraries for Windows (VS 2008)
+   <http://qt-project.org/downloads/>`_.
+
+#. Install `Cmake 2.8
+   <http://www.cmake.org/cmake/resources/software.html>`_.
+
+#. Install `MS Visual Studio Express 2008
+   <http://www.microsoft.com/express/Downloads/>`_.
+
+#. Install `Git 1.7
+   <http://git-scm.com/download/win>`_.
+
+#. (Optional) Install `OpenSSL
+   <http://slproweb.com/products/Win32OpenSSL.html>`_.
 
-      $ sudo apt-get install cmake
-   
 #. Install latest `distribute` distribution into the Python you
    installed in the first step: download `distribute_setup.py
    <http://python-distribute.org/distribute_setup.py>`_ and run it using
@@ -47,50 +50,92 @@ Installing PySide on a UNIX System (Ubuntu 12.04 LTS)
 
    .. code-block:: text
 
-      $ sudo python distribute_setup.py
+      c:\> c:\Python27\python distribute_setup.py
 
 #. Use that Python's `bin/easy_install` to install `virtualenv`:
 
    .. code-block:: text
 
-      $ sudo easy_install virtualenv
+      c:\> c:\Python27\Scripts\easy_install virtualenv
 
 #. Use that Python's virtualenv to make a workspace:
 
    .. code-block:: text
 
-      $ virtualenv env
+      c:\> c:\Python27\Scripts\virtualenv env
 
 #. Switch to the ``env`` directory:
 
    .. code-block:: text
 
-      $ cd env
+      c:\> cd env
+
+Installing PySide
+-----------------
+
+Use ``pip`` to get `PySide` installed:
+
+.. code-block:: text
+
+   c:\env> Scripts\pip install PySide --install-option="--qmake=c:\\Qt\\4.8.2\\bin\\qmake.exe"
+
+Optionally you can specify the path to OpenSSL libs:
+
+.. code-block:: text
 
-#. Use ``pip`` to get `PySide` installed:
+   c:\env> Scripts\pip install PySide --install-option="--openssl=c:\\Alfa\\OpenSSL32bit\\bin" --install-option="--qmake=c:\\Qt\\4.8.2\\bin\\qmake.exe"
+
+Building PySide installer
+-------------------------
+
+#. Clone ``PySide`` from git repository:
 
    .. code-block:: text
 
-      $ env/bin/pip install PySide
+      c:\> git clone https://github.com/PySide/pyside-setup.git pyside-setup
 
-Installing PySide on a Windows System
-=====================================
+#. Switch to the ``pyside-setup`` directory:
 
-#. Install `Python 2.7
-   <http://python.org/download/releases/2.7.3/>`_.
+   .. code-block:: text
 
-#. Install `Qt 4.8 libraries for Windows (VS 2008)
-   <http://qt-project.org/downloads/>`_.
+      c:\> cd pyside-setup
 
-#. Install `Cmake 2.8
-   <http://www.cmake.org/cmake/resources/software.html>`_.
+#. Build ``PySide`` windows installer:
 
-#. Install `MS Visual Studio Express 2008
-   <http://www.microsoft.com/express/Downloads/>`_.
+   .. code-block:: text
+
+      c:\> c:\Python27\python setup.py bdist_wininst --qmake=c:\Qt\4.8.2\bin\qmake.exe
+
+Installing PySide from source on a UNIX System (Ubuntu 12.04 LTS)
+=================================================================
+
+Installing prerequisities
+-------------------------
+
+#. Install Python 2.7 header files and a static library:
     
-#. (Optional) Install `OpenSSL
-   <http://slproweb.com/products/Win32OpenSSL.html>`_.
+   .. code-block:: text
+
+      $ sudo apt-get install python2.7-dev
+   
+#. Install Qt 4.8 libraries:
+    
+   .. code-block:: text
+
+      $ sudo apt-get install qt-sdk
+   
+#. Install cmake:
+    
+   .. code-block:: text
+
+      $ sudo apt-get install cmake
+
+#. Install git:
+    
+   .. code-block:: text
 
+      $ sudo apt-get install git
+   
 #. Install latest `distribute` distribution into the Python you
    installed in the first step: download `distribute_setup.py
    <http://python-distribute.org/distribute_setup.py>`_ and run it using
@@ -99,31 +144,47 @@ Installing PySide on a Windows System
 
    .. code-block:: text
 
-      c:\> c:\Python27\python distribute_setup.py
+      $ sudo python distribute_setup.py
 
 #. Use that Python's `bin/easy_install` to install `virtualenv`:
 
    .. code-block:: text
 
-      c:\> c:\Python27\Scripts\easy_install virtualenv
+      $ sudo easy_install virtualenv
 
 #. Use that Python's virtualenv to make a workspace:
 
    .. code-block:: text
 
-      c:\> c:\Python27\Scripts\virtualenv env
+      $ virtualenv env
 
-#. Switch to the ``env`` directory:
+Installing PySide
+-----------------
 
-   .. code-block:: text
+Use ``pip`` to get `PySide` installed from PyPI:
 
-      c:\> cd env
+.. code-block:: text
 
-#. Use ``pip`` to get `PySide` installed:
+   $ env/bin/pip install PySide
 
-   .. code-block:: text
+Alternatively you can install development version of `PySide` from github repository:
+
+.. code-block:: text
+
+   $ env/bin/pip install git+https://github.com/PySide/pyside-setup.git
+
+You can also specify version of `PySide` when installing from github repository:
+
+.. code-block:: text
+
+   $ env/bin/pip install git+https://github.com/PySide/pyside-setup.git@1.1.1
+
+Feedback and getting involved
+=============================
 
-      c:\env> Scripts\pip install PySide
+- Mailing list: http://lists.qt-project.org/mailman/listinfo/pyside
+- Issue tracker: https://bugreports.qt-project.org/browse/PYSIDE
+- Code Repository: http://qt.gitorious.org/pyside
 
 Changes
 =======
-- 
cgit v1.2.3