1# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation 2 3 SCons - a software construction tool 4 5This is the scons-README file for a version of SCons packaged for local 6execution--that is, execution out of a specific local directory, without 7having to install SCons as a system-wide utility. 8 9You are likely reading this file in one of the following two situations: 10 11 1) You have unpacked an scons-local-{version} package and are 12 examining the contents. 13 14 In this case, you are presumably interested in using this 15 package to include a local copy of SCons with some other 16 software that you package, so that you can use SCons to build 17 your software without forcing all of your users to have it fully 18 installed. Instructions for this can be found below. 19 20 If you are not looking to use SCons in this way, then please 21 use either the scons-{version} package to install SCons on your 22 system, or the scons-src-{version} package if you want the full 23 source to SCons, including its packaging code and underlying 24 tests and testing infrastructure. 25 26 2) This file was included in some other software package so that 27 the package could be built using SCons. 28 29 In this case, follow the instructions provided with the 30 rest of the software package for how to use SCons to build 31 and/or install the software. The file containing build and 32 installation instructions will typically be named README or 33 INSTALL. 34 35LATEST VERSION 36============== 37 38Before going further, you can check for the latest version of the 39scons-local package, or any SCons package, at the SCons download page: 40 41 http://www.scons.org/download.html 42 43 44EXECUTION REQUIREMENTS 45====================== 46 47Running SCons requires Python version 1.5.2 or later. There should be 48no other dependencies or requirements to run SCons. 49 50The default SCons configuration assumes use of the Microsoft Visual C++ 51compiler suite on WIN32 systems, and assumes a C compiler named 'cc', 52a C++ compiler named 'c++', and a Fortran compiler named 'g77' (such 53as found in the GNU C compiler suite) on any other type of system. 54You may, of course, override these default values by appropriate 55configuration of Environment construction variables. 56 57 58INSTALLATION 59============ 60 61Installation of this package should be as simple as unpacking the 62archive (either .tar.gz or .zip) in any directory (top-level or a 63subdirectory) within the software package with which you want to ship 64SCons. 65 66Once you have installed this package, you should write an SConstruct 67file at the top level of your source tree to build your software as you 68see fit. 69 70Then modify the build/install instructions for your package to instruct 71your users to execute SCons as follows (if you installed this package in 72your top-level directory): 73 74 $ python scons.py 75 76Or (if, for example, you installed this package in a subdirectory named 77"scons"): 78 79 $ python scons/scons.py 80 81That should be all you have to do. (If it isn't that simple, please let 82us know!) 83 84 85CONTENTS OF THIS PACKAGE 86======================== 87 88This scons-local package consists of the following: 89 90scons-LICENSE 91 A copy of the copyright and terms under which SCons is 92 distributed (the Open Source Initiative-approved MIT license). 93 94 A disclaimer has been added to the beginning to make clear that 95 this license applies only to SCons, and not to any separate 96 software you've written with which you're planning to package 97 SCons. 98 99scons-README 100 What you're looking at right now. 101 102scons-local-{version}/ 103 The SCons build engine. This is structured as a Python 104 library. 105 106scons.py 107 The SCons script itself. The script sets up the Python 108 sys.path variable to use the build engine found in the 109 scons-local-{version}/ directory in preference to any other 110 SCons build engine installed on your system. 111 112 113DOCUMENTATION 114============= 115 116Because this package is intended to be included with other software by 117experienced users, we have not included any SCons documentation in this 118package (other than this scons-README file you're reading right now). 119 120If, however, you need documentation about SCons, then consult any of the 121following from the corresponding scons-{version} or scons-src-{version} 122package: 123 124 The RELEASE.txt file (src/RELEASE.txt file in the 125 scons-src-{version} package), which contains notes about this 126 specific release, including known problems. 127 128 The CHANGES.txt file (src/CHANGES.txt file in the 129 scons-src-{version} package), which contains a list of changes 130 since the previous release. 131 132 The scons.1 man page (doc/man/scons.1 in the scons-src-{version} 133 package), which contains a section of small examples for getting 134 started using SCons. 135 136Additional documentation for SCons is available at: 137 138 http://www.scons.org/doc.html 139 140 141LICENSING 142========= 143 144SCons is distributed under the MIT license, a full copy of which is 145available in the scons-LICENSE file in this package. The MIT license is 146an approved Open Source license, which means: 147 148 This software is OSI Certified Open Source Software. OSI 149 Certified is a certification mark of the Open Source Initiative. 150 151More information about OSI certifications and Open Source software is 152available at: 153 154 http://www.opensource.org/ 155 156 157REPORTING BUGS 158============== 159 160You can report bugs either by following the "Tracker - Bugs" link 161on the SCons project page: 162 163 http://sourceforge.net/projects/scons/ 164 165or by sending mail to the SCons developers mailing list: 166 167 scons-devel@lists.sourceforge.net 168 169 170MAILING LISTS 171============= 172 173A mailing list for users of SCons is available. You may send questions 174or comments to the list at: 175 176 scons-users@lists.sourceforge.net 177 178You may subscribe to the scons-users mailing list at: 179 180 http://lists.sourceforge.net/lists/listinfo/scons-users 181 182 183FOR MORE INFORMATION 184==================== 185 186Check the SCons web site at: 187 188 http://www.scons.org/ 189 190 191AUTHOR INFO 192=========== 193 194Steven Knight 195knight at baldmt dot com 196http://www.baldmt.com/~knight/ 197 198With plenty of help from the SCons Development team: 199 Chad Austin 200 Charles Crain 201 Steve Leblanc 202 Anthony Roach 203 Terrel Shumway 204 205