README-local

   1
   2                  SCons - a software construction tool
   3
   4 This is the scons-README file for a version of SCons packaged for local
   5 execution--that is, execution out of a specific local directory, without
   6 having to install SCons as a system-wide utility.
   7
   8 You are likely reading this file in one of the following two situations:
   9
  10     1)  You have unpacked an scons-local-{version} package and are
  11         examining the contents.
  12
  13         In this case, you are presumably interested in using this
  14         package to include a local copy of SCons with some other
  15         software that you package, so that you can use SCons to build
  16         your software without forcing all of your users to have it fully
  17         installed.  Instructions for this can be found below.
  18
  19         If you are not looking to use SCons in this way, then please
  20         use either the scons-{version} package to install SCons on your
  21         system, or the scons-src-{version} package if you want the full
  22         source to SCons, including its packaging code and underlying
  23         tests and testing infrastructure.
  24
  25     2)  This file was included in some other software package so that
  26         the package could be built using SCons.
  27
  28         In this case, follow the instructions provided with the
  29         rest of the software package for how to use SCons to build
  30         and/or install the software.  The file containing build and
  31         installation instructions will typically be named README or
  32         INSTALL.
  33
  34 LATEST VERSION
  35 ==============
  36
  37 Before going further, you can check for the latest version of the
  38 scons-local package, or any SCons package, at the SCons download page:
  39
  40         https://scons.org/pages/download.html
  41
  42
  43 EXECUTION REQUIREMENTS
  44 ======================
  45
  46 Running SCons requires Python 3.5 or higher.
  47 There should be no other dependencies or requirements to run SCons.
  48
  49 As of SCons 4.2.0 support for Python 3.5 is deprecated and will be removed
  50 with the next major release.
  51
  52 The default SCons configuration assumes use of the Microsoft Visual C++
  53 compiler suite on WIN32 systems (either through the Visual Studio
  54 product, or through the separate Build Tools), and assumes a C compiler
  55 named 'cc', a C++ compiler named 'c++', and a Fortran compiler named 'g77'
  56 (such as found in the GNU Compiler Collection) on any other type of system.
  57 You may, of course, override these default values by appropriate
  58 configuration of Environment construction variables.
  59
  60
  61 INSTALLATION
  62 ============
  63
  64 Installation of this package should be as simple as unpacking the
  65 archive (either .tar.gz or .zip) in any directory (top-level or a
  66 subdirectory) within the software package with which you want to ship
  67 SCons.
  68
  69 Once you have installed this package, you should write an SConstruct
  70 file at the top level of your source tree to build your software as you
  71 see fit.
  72
  73 Then modify the build/install instructions for your package to instruct
  74 your users to execute SCons as follows (if you installed this package in
  75 your top-level directory):
  76
  77         $ python scons.py
  78
  79 Or (if, for example, you installed this package in a subdirectory named
  80 "scons"):
  81
  82         $ python scons/scons.py
  83
  84 That should be all you have to do.  (If it isn't that simple, please let
  85 us know!)
  86
  87
  88 CONTENTS OF THIS PACKAGE
  89 ========================
  90
  91 This scons-local package consists of the following:
  92
  93 scons-LICENSE
  94         A copy of the copyright and terms under which SCons is
  95         distributed (the Open Source Initiative-approved MIT license).
  96
  97         A disclaimer has been added to the beginning to make clear that
  98         this license applies only to SCons, and not to any separate
  99         software you've written with which you're planning to package
 100         SCons.
 101
 102 scons-README
 103         What you're looking at right now.
 104
 105 scons-local-{version}/
 106         The SCons build engine.  This is structured as a Python
 107         library.
 108
 109 scons.py
 110         The SCons script itself.  The script sets up the Python
 111         sys.path variable to use the build engine found in the
 112         scons-local-{version}/ directory in preference to any other
 113         SCons build engine installed on your system.
 114
 115
 116 DOCUMENTATION
 117 =============
 118
 119 Because this package is intended to be included with other software by
 120 experienced users, we have not included any SCons documentation in this
 121 package (other than this scons-README file you're reading right now).
 122
 123 If, however, you need documentation about SCons, then consult any of the
 124 following from the corresponding scons-{version} or scons-src-{version}
 125 package:
 126
 127         The RELEASE.txt file (src/RELEASE.txt file in the
 128         scons-src-{version} package), which contains notes about this
 129         specific release, including known problems.
 130
 131         The CHANGES.txt file (src/CHANGES.txt file in the
 132         scons-src-{version} package), which contains a list of changes
 133         since the previous release.
 134
 135         The scons.1 man page (doc/man/scons.1 in the scons-src-{version}
 136         package), which contains a section of small examples for getting
 137         started using SCons.
 138
 139 Additional documentation for SCons is available at:
 140
 141         http://www.scons.org/doc.html
 142
 143
 144 LICENSING
 145 =========
 146
 147 SCons is distributed under the MIT license, a full copy of which is
 148 available in the scons-LICENSE file in this package. The MIT license is
 149 an approved Open Source license, which means:
 150
 151         This software is OSI Certified Open Source Software.  OSI
 152         Certified is a certification mark of the Open Source Initiative.
 153
 154 More information about OSI certifications and Open Source software is
 155 available at:
 156
 157         http://www.opensource.org/
 158
 159
 160 REPORTING BUGS
 161 ==============
 162
 163 The SCons project welcomes bug reports and feature requests.
 164
 165 Please make sure you send email with the problem or feature request to
 166 the SCons users mailing list, which you can join via the link below:
 167
 168         http://two.pairlist.net/mailman/listinfo/scons-users
 169
 170 Once you have discussed your issue on the users mailing list and the
 171 community has confirmed that it is either a new bug or a duplicate of an
 172 existing bug, then please follow the instructions the community provides
 173 to file a new bug or to add yourself to the CC list for an existing bug
 174
 175 You can explore the list of existing bugs, which may include workarounds
 176 for the problem you've run into, on GitHub:
 177
 178         https://github.com/SCons/scons/issues
 179
 180
 181
 182 MAILING LISTS
 183 =============
 184
 185 A mailing list for users of SCons is available.  You may send questions
 186 or comments to the list at:
 187
 188         scons-users@scons.org
 189
 190 You may subscribe to the scons-users mailing list at:
 191
 192         http://two.pairlist.net/mailman/listinfo/scons-users
 193
 194 An active mailing list for developers of SCons is available.  You may
 195 send questions or comments to the list at:
 196
 197         scons-dev@scons.org
 198
 199 You may subscribe to the developer's mailing list using form on this page:
 200
 201         http://two.pairlist.net/mailman/listinfo/scons-dev
 202
 203 Subscription to the developer's mailing list is by approval.  In practice, no
 204 one is refused list membership, but we reserve the right to limit membership
 205 in the future and/or weed out lurkers.
 206
 207 There are other mailing lists available for SCons users, for notification of
 208 SCons code changes, and for notification of updated bug reports and project
 209 documents.  Please see our mailing lists page for details.
 210
 211
 212
 213 FOR MORE INFORMATION
 214 ====================
 215
 216 Check the SCons web site at:
 217
 218         http://www.scons.org/
 219
 220
 221 Author Info
 222 ===========
 223
 224 SCons was originally written by Steven Knight, knight at baldmt dot com.
 225 Since around 2010 it has been maintained by the SCons
 226 development team, co-managed by Bill Deegan and Gary Oberbrunner, with
 227 many contributors, including but not at all limited to:
 228
 229 - Chad Austin
 230 - Dirk Baechle
 231 - Charles Crain
 232 - William Deegan
 233 - Steve Leblanc
 234 - Rob Managan
 235 - Greg Noel
 236 - Gary Oberbrunner
 237 - Anthony Roach
 238 - Greg Spencer
 239 - Tom Tanner
 240 - Anatoly Techtonik
 241 - Christoph Wiedemann
 242 - Mats Wichmann
 243 - Russel Winder
 244 - Mats Wichmann
 245
 246 \... and many others.