aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEthan <mr.smittye@gmail.com>2015-09-19 10:41:10 -0700
committerEthan <mr.smittye@gmail.com>2015-09-19 10:41:10 -0700
commit8ac6228f7a4707e23e7ff091e389d61ac5bad5d6 (patch)
treeb2ef322159b822e2123e8a3e15f9985d03a46a34 /README.md
parent2b737ff8faea49383e5574a07e45809c5509a1b5 (diff)
.rst to md for unified doc types.
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..148b4b628
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+#PySide2
+
+This is the main repository for PySide2, the latest and greatest version of the Python bindings of Qt.
+PySide 2 supports Qt4 and Qt5. For building, please read about [gettting the dependencies](https://github.com/PySide/pyside-setup2/wiki/Dependencies). Then download the sources by running `git clone --recursive https://github.com/PySide/pyside-setup2.git`.
+
+###Building
+
+####Windows
+On Windows, once you have gotten the dependencies and the source, `cd pyside-setup2.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
+```
+