From 186736d72074ba06c962900bcd8c2d49fd5e828d Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Tue, 11 Aug 2020 08:22:03 -0600 Subject: Tweak Installing Python section in User Guide [skip appveyor] Signed-off-by: Mats Wichmann --- doc/user/build-install.xml | 49 ++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index 87a86aa..c106dc5 100644 --- a/doc/user/build-install.xml +++ b/doc/user/build-install.xml @@ -110,12 +110,13 @@ Python 3.7.1 - Note to Windows users: there are many different ways Python - can get installed or invoked on Windows, it is beyond the scope - of this guide to unravel all of them. Try using the - Python launcher (see - PEP 397) - by using the name py instead of + Note to Windows users: there are a number of different ways Python + can be installed or invoked on Windows, it is beyond the scope + of this guide to unravel all of them. Many will have an additional + program called the Python launcher (described, + somewhat technically, in + PEP 397): + try using the command name py instead of python, if that is not available drop back to trying python. @@ -129,21 +130,23 @@ Python 3.7.1 If Python is not installed on your system, or is not findable in the current search path, you will see an error message - stating something like "command not found" + stating something like "command not found" (on UNIX or Linux) - or "'python' is not recognized - as an internal or external command, operable progam or batch file" + or "'python' is not recognized as an internal + or external command, operable progam or batch file" (on Windows cmd). - In that case, you need to install Python - (or fix the search path) + In that case, you need to either install Python + or fix the search path before you can install &SCons;. - The canonical location for information - about downloading and installing Python is - http://www.python.org/download/. - See that page and associated links to get started. + The canonical location for downloading Python + from Python's own website is: + https://www.python.org/download. + There are useful system-specific entries on setup and + usage to be found at: + https://docs.python.org/3/using @@ -153,7 +156,7 @@ Python 3.7.1 by other means, and is easier than installing from source code. Many such systems have separate packages for Python 2 and Python 3 - make sure the Python 3 package is - installed, as &SCons; requires it. + installed, as the latest &SCons; requires it. Building from source may still be a useful option if you need a version that is not offered by the distribution you are using. @@ -195,7 +198,7 @@ Python 3.7.1 For those users using Anaconda or Miniconda, use the conda installer instead, so the &scons; install location will match the version of Python that - system will be using: + system will be using. For example: @@ -211,14 +214,14 @@ Python 3.7.1 During the still-ongoing Python 2 to 3 transition, some distributions may still have two &SCons; packages available, one which uses Python 2 and one which uses Python 3. Since - latest &scons; only runs on Python 3, to get the current version + the latest &scons; only runs on Python 3, to get the current version you should choose the Python 3 package. If you need a specific version of &SCons; that is different from the package available, - pip has a version option or you can follow + pip has a version option or you can follow the instructions in the next section. @@ -229,9 +232,9 @@ Python 3.7.1 If a pre-built &SCons; package is not available for your system, - and installing using pip is not suitable, + and installing using pip is not suitable, then you can still easily build and install &SCons; using the native - Python distutils package. + Python setuptools package. @@ -265,11 +268,11 @@ Python 3.7.1 install the &scons; script in the python which is used to run the setup.py's scripts directory (/usr/local/bin or - C:\Python27\Scripts), + C:\Python37\Scripts), and will install the &SCons; build engine in the corresponding library directory for the python used (/usr/local/lib/scons or - C:\Python27\scons). + C:\Python37\scons). Because these are system directories, you may need root (on Linux or UNIX) or Administrator (on Windows) privileges to install &SCons; like this. -- cgit v0.12