From 2d6b78ea3307b0193858d44863f41b1e40645a2f Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Thu, 21 Mar 2019 13:59:20 +0100 Subject: Doc: Add subtitles to Getting Started to improve readability Also added the necessary leading paragraphs. Change-Id: Ie8682e878aa8470ee8ca1f3231d0c8ccc14bc68d Reviewed-by: Friedemann Kleint Reviewed-by: Cristian Maureira-Fredes Reviewed-by: Venugopal Shivashankar --- sources/pyside2/doc/gettingstarted.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'sources/pyside2/doc') diff --git a/sources/pyside2/doc/gettingstarted.rst b/sources/pyside2/doc/gettingstarted.rst index 0a58226a7..cc915a5cb 100644 --- a/sources/pyside2/doc/gettingstarted.rst +++ b/sources/pyside2/doc/gettingstarted.rst @@ -2,13 +2,21 @@ Getting Started =============== -To get started with |project|, install the following prerequisites: +To develop with |project|, you must install Python, Clang, and |project|. + +Preparing for the Installation +============================== + +Before you can install |project|, you must install the following software: * Python 3.5+ or 2.7 * libclang 5.0+ (for Qt 5.11) or 6.0+ (for Qt 5.12) * Recommended: a virtual environment, such as `venv `_ or `virtualenv `_ -With these installed, you are ready to install the |project| +Installing |project| +==================== + +After you have installed the required software, you are ready to install the |project| packages using the pip wheel. Run the following command from your command prompt to install:: @@ -18,6 +26,9 @@ or:: pip install --index-url=http://download.qt.io/snapshots/ci/pyside/5.12/latest pyside2 --trusted-host download.qt.io +Testing the Installation +======================== + Now that you have |project| installed, you can test your setup by running the following Python constructs to print version information: @@ -25,6 +36,9 @@ constructs to print version information: :start-line: 5 :end-line: 32 +Creating a Simple Application +============================= + Your |project| setup is ready, so try exploring it further by developing a simple application that prints "Hello World" in several languages. The following instructions will guide you through the development process: -- cgit v1.2.3