diff options
author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-06-11 16:23:10 +0200 |
---|---|---|
committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-06-12 11:26:48 +0200 |
commit | b4098737b13c91ca85b69362426f0f30768c49b1 (patch) | |
tree | 887b093f9f7feaa05e0e6ee82698711b769d5bc5 /sources/pyside2/doc/deployment-cxfreeze.rst | |
parent | 086736b4d51e004a633947fe612bfdf0cd3478b1 (diff) |
Doc: Minor language edits
- reordered a few sentences
- removed a few redundant bits
Change-Id: I111dc51b7912a056ec8d9dc3bc765e9d374b6060
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside2/doc/deployment-cxfreeze.rst')
-rw-r--r-- | sources/pyside2/doc/deployment-cxfreeze.rst | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/sources/pyside2/doc/deployment-cxfreeze.rst b/sources/pyside2/doc/deployment-cxfreeze.rst index 40b65621b..f0a71ca80 100644 --- a/sources/pyside2/doc/deployment-cxfreeze.rst +++ b/sources/pyside2/doc/deployment-cxfreeze.rst @@ -2,10 +2,9 @@ |project| & cx_Freeze ===================== -`cx_Freeze <https://anthony-tuininga.github.io/cx_Freeze/>`_ allows you to freeze your Python -application into executables. -The supported platforms are Linux, macOS, Windows, FreeBSD, among others. - +`cx_Freeze <https://anthony-tuininga.github.io/cx_Freeze/>`_ lets you +freeze your Python application into executables. The supported +platforms are Linux, macOS, Windows, FreeBSD, among others. You can read the `official documentation <https://cx-freeze.readthedocs.io/en/latest/index.html>`_ to clarify any further question, and remember to contribute to @@ -15,7 +14,7 @@ if you find any, or contributing to `their development <https://bitbucket.org/an Preparation =========== -Installing `cx_Freeze` can be done via **pip**:: +Installing `cx_Freeze` can be done using **pip**:: pip install cx_freeze @@ -34,7 +33,7 @@ There are three options to work with `cx_Freeze`: 2. Creating `setup.py` script to build the project. 3. Using the module classes directly (for advanced purposes). -We will cover the first two uses cases. +The following sections cover the first two use cases. Creating an example ------------------- @@ -83,15 +82,16 @@ Now, consider the following simple script, named `hello.py`:: Using `cxfreeze` executable --------------------------- -The command line to proceed will look like this:: +Now that we have an application, try freezing it with the following +command:: cxfreeze hello.py -This command will create a `dist/` directory that will contain the -executable and a `lib/` directory including all the shared libraries. +This command creates a `dist/` directory containing the executable. +and a `lib/` directory containing all the shared libraries. -To launch the application, you need to just go to the `dist/` directory -and execute the file:: +To launch the application, go to the `dist/` directory and execute +the file:: cd dist/ ./main @@ -100,7 +100,7 @@ and execute the file:: Using a setuptools script ------------------------- -For this process, you will need an additional script called `setup.py`:: +For this process, you need an additional script called `setup.py`:: import sys from cx_Freeze import setup, Executable @@ -110,18 +110,18 @@ For this process, you will need an additional script called `setup.py`:: description = "My GUI App", executables = [Executable("hello.py")]) -After that, you need to build the project using it:: +Now, build the project using it:: python setup.py build -This step will create a `build/` directory with the following structure:: +This step creates a `build/` directory with the following structure:: build └── exe.linux-x86_64-3.7 └── lib └── main -The first directory inside `build/` will depend on the platform +The first directory inside `build/` depends on the platform you are using, in this case a `x86_64` Linux using Python 3.7. The structure is the same as previously described, and you can simply enter the directory and execute the file:: |