David,
I did a partial edit of the manual as given on your github site. My diffs
are below. Is this readable / helpful?
Bryan
diff --git a/doc/source/Manual.rst b/doc/source/Manual.rst
index 93c6dd2..bfdee28 100644
--- a/doc/source/Manual.rst
+++ b/doc/source/Manual.rst
@@ -98,7 +98,7 @@ you can download and install |PyInstaller| in one
command, for example::
pip install pyinstaller
-and upgrade to a newer version in one command,::
+and upgrade to a newer version in one command::
pip install --upgrade pyinstaller
@@ -142,9 +142,9 @@ Installing from the archive
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also install |PyInstaller| by downloading the compressed archive
-from pypi_ and expanding the archive.
+from PyPI_ and expanding the archive.
-Inside the archive is a script ``setup.py``.
+Inside the archive is a script named ``setup.py``.
Execute ``python setup.py install``
with administrator privilege to install or upgrade |PyInstaller|.
@@ -156,17 +156,17 @@ For platforms other than Windows, Linux and Mac OS,
you must build a
* Make a bootloader with: ``python ./waf configure build install``.
If this reports an error, read `Building the Bootloader`_ below,
-and then ask for technical help.
+then ask for technical help.
It is of no use to continue the installation without a |bootloader|.
After the |bootloader| has been created,
-you can run ``python setup.py install`` with administrator privilege
+you can run ``python setup.py install`` with administrator privileges
to complete the installation.
Verifying the installation
~~~~~~~~~~~~~~~~~~~~~~~~~~
On all platforms, the command ``pyinstaller`` should now exist on the
-execution path. To verify this enter the command
+execution path. To verify this, enter the command
``pyinstaller --version``
@@ -176,9 +176,9 @@ and ``2.1dev-xxxxxx`` for a development branch.
If the command is not found, make sure the execution path includes
the proper directory:
-* Windows: ``C:\PythonXY\Scripts``
+* Windows: ``C:\PythonXY\Scripts`` (where XY represents the major and
minor Python version number, e.g. Python 27)
* Linux: ``/usr/bin/``
-* OS X (using default Apple-supplied Python) ``/usr/local/bin``
+* OS X (using the default Apple-supplied Python) ``/usr/local/bin``
* OS X (using Python installed by macports) ``/opt/local/bin``
To display the current path in Windows the command is ``echo %path%``
@@ -216,14 +216,14 @@ by running Python scripts found in the distribution
folder.
The equivalent of the ``pyinstaller`` command is
*pyinstaller-folder* ``/pyinstaller.py``.
The other commands are found in *pyinstaller-folder* ``/cliutils/``
-with obvious names (``makespec.py`` and etc.)
+with obvious names (``makespec.py``, etc.)
Overview: What |PyInstaller| Does and How It Does It
============================================================
This section covers the basic ideas of |PyInstaller|.
These ideas apply to all platforms.
-There are many options, exceptions, and special cases covered under `Using
PyInstaller`_ .
+There are many options, exceptions, and special cases covered under `Using
PyInstaller`_.
|PyInstaller| reads a Python script written by you.
First it analyzes your code to discover every other file
@@ -287,7 +287,7 @@ Bundling to One Folder
When you apply |PyInstaller| to ``myscript.py`` the default
result is a single folder named ``myscript``.
-This folder contains all the
+This folder contains all the necessary
support files, and an executable file also named ``myscript``
(``myscript.exe`` in Windows).
@@ -366,7 +366,7 @@ The folder is named ``_MEIxxxxxx``, where ``xxxxxx`` is
a random number.
The one file contains an embedded archive of all the Python
modules used by your script, as well as
compressed copies of any non-Python support files (e.g. ``.so`` files).
-The boot loader uncompresses the support files and writes copies
+The |bootloader| uncompresses the support files and writes copies
into the the temporary folder.
This can take a little time.
That is why a one-file app is a little slower to start
@@ -488,7 +488,7 @@ General Options
Print a summary of the options and exit.
-v, --version
- Print the version of the program as 2. *n* -*xxxxxxx* where *n* is the
+ Print the version of the program as 2.\ *n*-*xxxxxxx* where *n* is the
sub-version and *xxxxxxx* is a git commit tag.
-a, --ascii
@@ -496,16 +496,16 @@ General Options
The default is to include them if available, whether the script
imports them or not.
--distpath=path_to_executable, -o path_to_executable
- Say where to put the bundled app.
+ Specify where to put the bundled app.
The default is a ``dist`` folder in
the same folder as the first script.
--specpath=path_to_spec_file
- Say where to put the *name* `.spec` file.
+ Specify where to put the *name*\ `.spec` file.
The default is the same folder as the first script.
--workpath=path_to_work_files
- Say where to put the |PyInstaller| log and work files for this run.
+ Specify where to put the |PyInstaller| log and work files for this run.
The default path is a ``build`` folder
in the same folder as the first script or spec.
@@ -726,7 +726,7 @@ You will run the same command again and again as you
develop
your script.
You can put the command in a shell script or batch file,
using line continuations to make it readable.
-For example in Linux::
+For example, in Linux::
pyinstaller --noconfirm --log-level=WARN \
--onefile --nowindow \
@@ -887,7 +887,7 @@ When you create a spec file, many command options are
written into the spec file
When you build from a spec file, those options cannot be changed.
If they are given on the command line they are ignored and
replaced by the options in the spec file.
-Only the following options have an effect when building from a spec file:
+Only the following command-line options have an effect when building from
a spec file:
* --upx-dir=
* --distpath=
On Thu, Apr 11, 2013 at 5:26 PM, David Cortesi <[email protected]>wrote:
> I have made considerable changes in the draft documentation
> file for the upcoming 2.1 release. I would very much
> appreciate any review comments. Read it here (careful, long URL)
>
>
> http://htmlpreview.github.com/?https://github.com/tallforasmurf/pyinstaller/blob/master/doc/Manual.html
>
> If you do nothing else, search that page for "??" which flags
> areas of my ignorance. Input on topics flagged ?? is badly needed.
>
> The doc *especially* needs help from anyone who has actual
> experience with:
>
> * using WINE to cross-develop for Windows on Linux or Mac.
> * writing a hook
> * writing a run-time hook
> * compiling the bootloader
>
> Thanks for your time,
>
> Dave Cortesi
>
> --
> You received this message because you are subscribed to the Google Groups
> "PyInstaller" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to [email protected].
> To post to this group, send email to [email protected].
> Visit this group at http://groups.google.com/group/pyinstaller?hl=en.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>
>
--
Bryan A. Jones, Ph.D.
Associate Professor
Department of Electrical and Computer Engineering
231 Simrall / PO Box 9571
Mississippi State University
Mississippi state, MS 39762
http://www.ece.msstate.edu/~bjones
bjones AT ece DOT msstate DOT edu
voice 662-325-3149
fax 662-325-2298
Our Master, Jesus Christ, is on his way. He'll show up right on
time, his arrival guaranteed by the Blessed and Undisputed Ruler,
High King, High God.
- 1 Tim. 6:14b-15 (The Message)
--
You received this message because you are subscribed to the Google Groups
"PyInstaller" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/pyinstaller?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
