aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2017-03-20 17:20:36 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2017-04-06 12:46:21 +0000
commit1804b43298846fdfec51807a337ef42cec39b540 (patch)
tree16ad443adae7dc56e740f187d5879df02cdcd6ba /README.md
parent9ab9166d3d41eeb9d0331b1c309bf646690ad413 (diff)
Fix README.md
Fix formatting, remove unrelated links and add a link to the "Getting started" page of the Wiki. Change-Id: If6dcf40693dbaab7baf21d4b65c91f3cee4ebb94 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 21 insertions, 26 deletions
diff --git a/README.md b/README.md
index e654276ce..e3f967d7f 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,33 @@
-#PySide2
+# PySide2
-| Windows | Linux |
-|---------|-------|
-| [![AppVeyor](https://img.shields.io/appveyor/ci/techtonik/pyside2-setup.svg)](https://ci.appveyor.com/project/techtonik/pyside2-setup) | [![Travis CI](https://img.shields.io/travis/PySide/pyside2-setup.svg)](https://travis-ci.org/PySide/pyside2-setup) |
+### Introduction
-
-###Introduction
-
-
-
-
-PySide is the [Python Qt bindings project](http://wiki.qt.io/PySide2), providing access the complete Qt 5.x framework
-as well as to generator tools for rapidly generating bindings for any C++ libraries.
+PySide is the [Python Qt bindings project](http://wiki.qt.io/PySide2), providing
+access to the complete Qt 5.x framework as well as to generator tools for rapidly
+generating bindings for any C++ libraries.
The PySide project is developed in the open, with all facilities you'd expect
-from any modern OSS project such as all code in a git repository and an open design process. We welcome
-any contribution conforming to the [Qt Contribution Agreement](https://www.qt.io/contributionagreement/).
-
+from any modern OSS project such as all code in a git repository and an open
+design process. We welcome any contribution conforming to the
+[Qt Contribution Agreement](https://www.qt.io/contributionagreement/).
-PySide 2 supports Qt5. For building, please read about [getting the dependencies](https://github.com/PySide/pyside2/wiki/Dependencies). Then download the sources by running `git clone --recursive https://code.qt.io/pyside/pyside-setup`.
-###Building
+PySide 2 supports Qt5. For building, please read about
+[getting started](https://wiki.qt.io/PySide2_GettingStarted).
+Then download the sources by running
-####Windows
-On Windows, once you have gotten the dependencies and the source, `cd pyside2-setup.git` to enter the directory and then:
-```
-python setup.py install --qmake=\path\to\bin\qmake --cmake=\path\to\bin\cmake --openssl=\path\to\openssl\bin
-```
+ git clone https://code.qt.io/pyside/pyside-setup
-####Linux
+### Building
+You might consider using a virtual environment as described at
+[getting started](https://wiki.qt.io/PySide2_GettingStarted).
You should be able to build:
-```
-python setup.py install --qmake=/path/to/bin/qmake --cmake=/path/to/bin/cmake --openssl=/path/to/openssl/bin
-```
+ cd pyside-setup
+ python setup.py install
+The setup script will try to find the location of the qmake tool of the Qt
+version to be used and the cmake build tool in the path. Non-standard
+locations can be specified by the *--qmake=path_to_qmake* or
+*--cmake=path_to_cmake* command line options.