aboutsummaryrefslogtreecommitdiffstats
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
parent2b737ff8faea49383e5574a07e45809c5509a1b5 (diff)
.rst to md for unified doc types.
-rw-r--r--README.md13
-rw-r--r--README.rst133
2 files changed, 13 insertions, 133 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
+```
+
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 26ab178e8..000000000
--- a/README.rst
+++ /dev/null
@@ -1,133 +0,0 @@
-=======
-PySide2
-=======
-
-.. image:: https://img.shields.io/pypi/wheel/pyside.svg
- :target: https://pypi.python.org/pypi/PySide/
- :alt: Wheel Status
-
-.. image:: https://img.shields.io/pypi/dm/pyside.svg
- :target: https://pypi.python.org/pypi/PySide/
- :alt: Downloads
-
-.. image:: https://img.shields.io/pypi/v/pyside.svg
- :target: https://pypi.python.org/pypi/PySide/
- :alt: Latest Version
-
-.. image:: https://binstar.org/asmeurer/pyside/badges/license.svg
- :target: https://pypi.python.org/pypi/PySide/
- :alt: License
-
-.. image:: https://readthedocs.org/projects/pip/badge/
- :target: https://pyside.readthedocs.org
-
-.. contents:: **Table of Contents**
- :depth: 2
-
-Introduction
-============
-
-.. note::
-
- This text is mostly from PySide 1.2.X. We need to update it when
- PySide2 for Qt5 is more ready.
-
-
-PySide is the Python Qt bindings project, providing access the complete Qt 4.8 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, an open
-Bugzilla for reporting bugs, and an open design process. We welcome
-any contribution without requiring a transfer of copyright.
-
-The PySide documentation is hosted at `http://pyside.github.io/docs/pyside/
-<http://pyside.github.io/docs/pyside/>`_.
-
-Compatibility
-=============
-
-PySide requires Python 2.6 or later and Qt 4.6 or better.
-
-.. note::
-
- Qt 5.x is currently in the works.
-
-Installation
-============
-
-Installing prerequisites
-------------------------
-
-Install latest ``pip`` distribution: download `get-pip.py
-<https://bootstrap.pypa.io/get-pip.py>`_ and run it using
-the ``python`` interpreter.
-
-Installing PySide on a Windows System
--------------------------------------
-
-To install PySide on Windows you can choose from the following options:
-
-#. Use pip to install the ``wheel`` binary packages:
-
- ::
-
- pip install -U PySide
-
-#. Use setuptools to install the ``egg`` binary packages (deprecated):
-
- ::
-
- easy_install -U PySide
-
-.. note::
-
- Provided binaries are without any other external dependencies.
- All required Qt libraries, development tools and examples are included.
-
-
-Installing PySide on a Mac OS X System
---------------------------------------
-
-You need to install or build Qt 4.8 first, see the `Qt Project Documentation
-<http://qt-project.org/doc/qt-4.8/install-mac.html>`_.
-
-Alternatively you can use `Homebrew <http://brew.sh/>`_ and install Qt with
-
-::
-
- $ brew install qt
-
-To install PySide on Mac OS X you can choose from the following options:
-
-#. Use pip to install the ``wheel`` binary packages:
-
- ::
-
- $ pip install -U PySide
-
-
-Installing PySide on a Linux System
------------------------------------
-
-We do not provide binaries for Linux. Please read the build instructions in section
-`Building PySide on a Linux System
-<http://pyside.readthedocs.org/en/latest/building/linux.html>`_.
-
-
-Building PySide
-===============
-
-- `Building PySide on a Windows System <http://pyside.readthedocs.org/en/latest/building/windows.html>`_.
-
-- `Building PySide on a Mac OS X System <http://pyside.readthedocs.org/en/latest/building/macosx.html>`_.
-
-- `Building PySide on a Linux System <http://pyside.readthedocs.org/en/latest/building/linux.html>`_.
-
-
-Feedback and getting involved
-=============================
-
-- 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