From 0615575bb282d5dbe7af2c6385dad25e393c9394 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Tue, 30 Nov 2021 11:35:50 -0700 Subject: Trim installation section Removed the various guesses about where scons.exe might go and just refer to pip's message. Added a stub section on Getting Started. Signed-off-by: Mats Wichmann --- README.rst | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 84f242a..f4370cf 100755 --- a/README.rst +++ b/README.rst @@ -147,22 +147,12 @@ Some installation examples:: (myvenv) $ pip install --editable . Note that on Windows, SCons installed via ``pip`` puts an executable -``scons.exe`` in the script directory of the Python installation. -There are lots of possibilities depending on how you install Python -(e.g. python.org installer as a single-user install or all-users install; -Microsoft Store app; bundled by a third party such as Chocolatey; -as an installation option in Visual Studio), and then whether you -do a plain install or a user install with `pip`. You need to figure out -this directory and make sure it's added to the environment variable PATH. -Some possibilities:: - - C:\Python39\Scripts\ - C:\Users\me\AppData\Local\Program\Python\Python39\Scripts - # using pip --user: - C:\Users\me\AppData\Roaming\Python\Python39\Scripts - -Fortunately, ``pip`` will warn you about this - pay attention to the -message during installation:: +``scons.exe`` in the script directory of the Python installation, +or in a shadow script directory if you did a User Install. +To run ``scons`` as a command, you'll need this in your search path. + +Fortunately, ``pip`` will warn you about this - pay attention to any +messages during installation like this:: WARNING: The scripts scons-configure-cache.exe, scons.exe and sconsign.exe are installed in 'C:\Users\me\AppData\Roaming\Python\Python310\Scripts' @@ -179,6 +169,14 @@ very quickly, while others may delay, so the version of SCons you want to run may factor into your choice. +Getting Started Using SCons +=========================== + +If you're new to SCons, the first couple of chapters of the +`SCons User Guide `_ +provide an excellent starting spot. + + Contributing to SCons ===================== -- cgit v0.12