summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2018-02-20 15:01:26 (GMT)
committerWilliam Deegan <bill@baddogconsulting.com>2018-02-20 15:01:26 (GMT)
commita1a453e5046dbb1151eba2ca605d08b5d5820e81 (patch)
treea1af1d1e93f1921ab291c04f293d18c3cfb16110 /README.rst
parent32df95374e7ccb78ba677b5f287a437d12c0df4b (diff)
downloadSCons-a1a453e5046dbb1151eba2ca605d08b5d5820e81.zip
SCons-a1a453e5046dbb1151eba2ca605d08b5d5820e81.tar.gz
SCons-a1a453e5046dbb1151eba2ca605d08b5d5820e81.tar.bz2
Update README.rst. Was missing correct info on python 3.5+ support. [ci skip]
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst52
1 files changed, 23 insertions, 29 deletions
diff --git a/README.rst b/README.rst
index 8eb5af1..d63c8a4 100644
--- a/README.rst
+++ b/README.rst
@@ -72,9 +72,8 @@ version at the SCons download page:
Execution Requirements
======================
-Running SCons requires Python version 2.7 or later (Python 3 is not
-yet supported). There should be no other dependencies or requirements
-to run SCons.
+Running SCons requires Python version 2.7.* and Python 3.5 or higher.
+There should be no other dependencies or requirements to run SCons.
The default SCons configuration assumes use of the Microsoft Visual C++
compiler suite on WIN32 systems, and assumes a C compiler named 'cc', a C++
@@ -105,13 +104,11 @@ populate the build/scons/ subdirectory. You would do this as follows on a
Linux or UNIX system (using sh or a derivative like bash or ksh)::
$ setenv MYSCONS=`pwd`/src
- $ setenv SCONS_LIB_DIR=$MYSCONS/engine
$ python $MYSCONS/script/scons.py [arguments]
Or on Windows::
C:\scons>set MYSCONS=%cd%\src
- C:\scons>set SCONS_LIB_DIR=%MYSCONS%\engine
C:\scons>python %MYSCONS%\script\scons.py [arguments]
An alternative approach is to skip the above and use::
@@ -181,7 +178,7 @@ Or on Windows::
By default, the above commands will do the following:
-- Install the version-numbered "scons-3.0.0" and "sconsign-3.0.0" scripts in
+- Install the version-numbered "scons-3.1.0" and "sconsign-3.1.0" scripts in
the default system script directory (/usr/bin or C:\\Python\*\\Scripts, for
example). This can be disabled by specifying the "--no-version-script"
option on the command line.
@@ -193,23 +190,23 @@ By default, the above commands will do the following:
before making it the default on your system.
On UNIX or Linux systems, you can have the "scons" and "sconsign" scripts be
- hard links or symbolic links to the "scons-3.0.0" and "sconsign-3.0.0"
+ hard links or symbolic links to the "scons-3.1.0" and "sconsign-3.1.0"
scripts by specifying the "--hardlink-scons" or "--symlink-scons" options on
the command line.
-- Install "scons-3.0.0.bat" and "scons.bat" wrapper scripts in the Python
+- Install "scons-3.1.0.bat" and "scons.bat" wrapper scripts in the Python
prefix directory on Windows (C:\\Python\*, for example). This can be disabled
by specifying the "--no-install-bat" option on the command line.
On UNIX or Linux systems, the "--install-bat" option may be specified to
- have "scons-3.0.0.bat" and "scons.bat" files installed in the default system
+ have "scons-3.1.0.bat" and "scons.bat" files installed in the default system
script directory, which is useful if you want to install SCons in a shared
file system directory that can be used to execute SCons from both UNIX/Linux
and Windows systems.
- Install the SCons build engine (a Python module) in an appropriate
- version-numbered SCons library directory (/usr/lib/scons-3.0.0 or
- C:\\Python\*\\scons-3.0.0, for example). See below for more options related to
+ version-numbered SCons library directory (/usr/lib/scons-3.1.0 or
+ C:\\Python\*\\scons-3.1.0, for example). See below for more options related to
installing the build engine library.
- Install the troff-format man pages in an appropriate directory on UNIX or
@@ -487,7 +484,7 @@ running all of "runtest.py -a".
Building Packages
=================
-We use SCons (version 3.0.0 or later) to build its own packages. If you
+We use SCons (version 3.1.0 or later) to build its own packages. If you
already have an appropriate version of SCons installed on your system, you can
build everything by simply running it::
@@ -502,9 +499,7 @@ about `Executing SCons Without Installing`_)::
Depending on the utilities installed on your system, any or all of the
following packages will be built::
- build/dist/scons-3.0.0-1.noarch.rpm
- build/dist/scons-3.0.0-1.src.rpm
- build/dist/scons-3.0.0.linux-i686.tar.gz
+ build/dist/scons-3.1.0.linux-i686.tar.gz
build/dist/scons-3.1.0.alpha.yyyymmdd.tar.gz
build/dist/scons-3.1.0.alpha.yyyymmdd.win32.exe
build/dist/scons-3.1.0.alpha.yyyymmdd.zip
@@ -513,7 +508,6 @@ following packages will be built::
build/dist/scons-local-3.1.0.alpha.yyyymmdd.zip
build/dist/scons-src-3.1.0.alpha.yyyymmdd.tar.gz
build/dist/scons-src-3.1.0.alpha.yyyymmdd.zip
- build/dist/scons_3.0.0-1_all.deb
The SConstruct file is supposed to be smart enough to avoid trying to build
packages for which you don't have the proper utilities installed. For
@@ -537,10 +531,6 @@ system, it should not try to install it.) The runtest.py script supports a -p
option that will run the specified tests (individually or collectively via
the -a option) against the unpacked build/test-/\* subdirectory::
- $ python runtest.py -p deb
-
- $ python runtest.py -p rpm
-
$ python runtest.py -p local-tar-gz
$ python runtest.py -p local-zip
@@ -690,18 +680,22 @@ in the LICENSE file.
Reporting Bugs
==============
-Please report bugs by following the detailed instructions on our Bug
-Submission page:
+The SCons project welcomes bug reports and feature requests.
- http://scons.tigris.org/bug-submission.html
+Please make sure you send email with the problem or feature request to the SCons user's mailing list,
+which you can join via the link below:
-You can also send mail to the SCons developers' mailing list:
+ http://two.pairlist.net/mailman/listinfo/scons-users
- scons-dev@scons.org
+Once you have discussed your issue on the users mailing list and the community has confirmed that
+it is either a new bug or a duplicate of an existing bug, then please follow the instructions the c
+ommunity provides to file a new bug or to add yourself to the CC list for an existing bug
+
+You can explore the list of existing bugs, which may include workarounds for the problem you've
+run into on GitHub Issues:
+
+ https://github.com/SCons/scons/issues
-But even if you send email to the mailing list please make sure that you ALSO
-submit a bug report to the project page bug tracker, because bug reports in
-email often get overlooked in the general flood of messages.
Mailing Lists
@@ -773,5 +767,5 @@ many contributors, including but not at all limited to:
\... and many others.
-Copyright (c) 2001 - 2017 The SCons Foundation
+Copyright (c) 2001 - 2018 The SCons Foundation