OLD | NEW |
(Empty) | |
| 1 |
| 2 |
| 3 SCons - a software construction tool |
| 4 |
| 5 Version 2.0.1 |
| 6 |
| 7 |
| 8 This is SCons, a tool for building software (and other files). SCons is |
| 9 implemented in Python, and its "configuration files" are actually Python |
| 10 scripts, allowing you to use the full power of a real scripting language |
| 11 to solve build problems. You do not, however, need to know Python to |
| 12 use SCons effectively. |
| 13 |
| 14 See the RELEASE.txt file for notes about this specific release, |
| 15 including known problems. See the CHANGES.txt file for a list of |
| 16 changes since the previous release. |
| 17 |
| 18 |
| 19 LATEST VERSION |
| 20 ============== |
| 21 |
| 22 Before going further, you can check that this package you have is |
| 23 the latest version by checking the SCons download page at: |
| 24 |
| 25 http://www.scons.org/download.html |
| 26 |
| 27 |
| 28 EXECUTION REQUIREMENTS |
| 29 ====================== |
| 30 |
| 31 Running SCons requires Python version 2.4 or later. There should be |
| 32 no other dependencies or requirements to run SCons. (There is, however, |
| 33 an additional requirement to *install* SCons from this particular |
| 34 package; see the next section.) |
| 35 |
| 36 By default, SCons knows how to search for available programming tools |
| 37 on various systems--see the SCons man page for details. You may, |
| 38 of course, override the default SCons choices made by appropriate |
| 39 configuration of Environment construction variables. |
| 40 |
| 41 |
| 42 INSTALLATION REQUIREMENTS |
| 43 ========================= |
| 44 |
| 45 Nothing special. |
| 46 |
| 47 |
| 48 INSTALLATION |
| 49 ============ |
| 50 |
| 51 Assuming your system satisfies the installation requirements in the |
| 52 previous section, install SCons from this package simply by running the |
| 53 provided Python-standard setup script as follows: |
| 54 |
| 55 # python setup.py install |
| 56 |
| 57 By default, the above command will do the following: |
| 58 |
| 59 -- Install the version-numbered "scons-2.0.1" and "sconsign-2.0.1" |
| 60 scripts in the default system script directory (/usr/bin or |
| 61 C:\Python*\Scripts, for example). This can be disabled by |
| 62 specifying the "--no-version-script" option on the command |
| 63 line. |
| 64 |
| 65 -- Install scripts named "scons" and "sconsign" scripts in the |
| 66 default system script directory (/usr/bin or C:\Python*\Scripts, |
| 67 for example). This can be disabled by specifying the |
| 68 "--no-scons-script" option on the command line, which is useful |
| 69 if you want to install and experiment with a new version before |
| 70 making it the default on your system. |
| 71 |
| 72 On UNIX or Linux systems, you can have the "scons" and "sconsign" |
| 73 scripts be hard links or symbolic links to the "scons-2.0.1" and |
| 74 "sconsign-2.0.1" scripts by specifying the "--hardlink-scons" |
| 75 or "--symlink-scons" options on the command line. |
| 76 |
| 77 -- Install "scons-2.0.1.bat" and "scons.bat" wrapper scripts in the |
| 78 Python prefix directory on Windows (C:\Python*, for example). |
| 79 This can be disabled by specifying the "--no-install-bat" option |
| 80 on the command line. |
| 81 |
| 82 On UNIX or Linux systems, the "--install-bat" option may be |
| 83 specified to have "scons-2.0.1.bat" and "scons.bat" files |
| 84 installed in the default system script directory, which is useful |
| 85 if you want to install SCons in a shared file system directory |
| 86 that can be used to execute SCons from both UNIX/Linux and |
| 87 Windows systems. |
| 88 |
| 89 -- Install the SCons build engine (a Python module) in an |
| 90 appropriate version-numbered SCons library directory |
| 91 (/usr/lib/scons-2.0.1 or C:\Python*\scons-2.0.1, for example). |
| 92 See below for more options related to installing the build |
| 93 engine library. |
| 94 |
| 95 -- Install the troff-format man pages in an appropriate directory |
| 96 on UNIX or Linux systems (/usr/share/man/man1 or /usr/man/man1, |
| 97 for example). This can be disabled by specifying the |
| 98 "--no-install-man" option on the command line. The man pages |
| 99 can be installed on Windows systems by specifying the |
| 100 "--install-man" option on the command line. |
| 101 |
| 102 Note that, by default, SCons does not install its build engine library |
| 103 in the standard Python library directories. If you want to be able to |
| 104 use the SCons library modules (the build engine) in other Python |
| 105 scripts, specify the "--standard-lib" option on the command line, as |
| 106 follows: |
| 107 |
| 108 # python setup.py install --standard-lib |
| 109 |
| 110 This will install the build engine in the standard Python library |
| 111 directory (/usr/lib/python*/site-packages or |
| 112 C:\Python*\Lib\site-packages). |
| 113 |
| 114 Alternatively, you can have SCons install its build engine library in a |
| 115 hard-coded standalone library directory, instead of the default |
| 116 version-numbered directory, by specifying the "--standalone-lib" option |
| 117 on the command line, as follows: |
| 118 |
| 119 # python setup.py install --standalone-lib |
| 120 |
| 121 This is usually not recommended, however. |
| 122 |
| 123 Note that, to install SCons in any of the above system directories, |
| 124 you should have system installation privileges (that is, "root" or |
| 125 "Administrator") when running the setup.py script. If you don't have |
| 126 system installation privileges, you can use the --prefix option to |
| 127 specify an alternate installation location, such as your home directory: |
| 128 |
| 129 $ python setup.py install --prefix=$HOME |
| 130 |
| 131 This will install SCons in the appropriate locations relative to |
| 132 $HOME--that is, the scons script itself $HOME/bin and the associated |
| 133 library in $HOME/lib/scons, for example. |
| 134 |
| 135 |
| 136 DOCUMENTATION |
| 137 ============= |
| 138 |
| 139 See the RELEASE.txt file for notes about this specific release, |
| 140 including known problems. See the CHANGES.txt file for a list of |
| 141 changes since the previous release. |
| 142 |
| 143 The scons.1 man page is included in this package, and contains a section |
| 144 of small examples for getting started using SCons. |
| 145 |
| 146 Additional documentation for SCons is available at: |
| 147 |
| 148 http://www.scons.org/doc.html |
| 149 |
| 150 |
| 151 LICENSING |
| 152 ========= |
| 153 |
| 154 SCons is distributed under the MIT license, a full copy of which is |
| 155 available in the LICENSE.txt file. The MIT license is an approved Open |
| 156 Source license, which means: |
| 157 |
| 158 This software is OSI Certified Open Source Software. OSI |
| 159 Certified is a certification mark of the Open Source Initiative. |
| 160 |
| 161 More information about OSI certifications and Open Source software is |
| 162 available at: |
| 163 |
| 164 http://www.opensource.org/ |
| 165 |
| 166 |
| 167 REPORTING BUGS |
| 168 ============== |
| 169 |
| 170 Please report bugs by following the detailed instructions on our Bug |
| 171 Submission page: |
| 172 |
| 173 http://scons.tigris.org/bug-submission.html |
| 174 |
| 175 You can also send mail to the SCons developers' mailing list: |
| 176 |
| 177 dev@scons.tigris.org |
| 178 |
| 179 But even if you send email to the mailing list please make sure that you |
| 180 ALSO submit a bug report to the project page bug tracker, because bug |
| 181 reports in email often get overlooked in the general flood of messages. |
| 182 |
| 183 |
| 184 MAILING LISTS |
| 185 ============= |
| 186 |
| 187 An active mailing list for users of SCons is available. You may send |
| 188 questions or comments to the list at: |
| 189 |
| 190 users@scons.tigris.org |
| 191 |
| 192 You may subscribe to the mailing list by sending email to: |
| 193 |
| 194 users-subscribe@scons.tigris.org |
| 195 |
| 196 There is also a low-volume mailing list available for announcements |
| 197 about SCons. Subscribe by sending email to: |
| 198 |
| 199 announce-subscribe@scons.tigris.org |
| 200 |
| 201 There are other mailing lists available for SCons developers, for |
| 202 notification of SCons code changes, and for notification of updated |
| 203 bug reports and project documents. Please see our mailing lists page |
| 204 for details. |
| 205 |
| 206 |
| 207 DONATIONS |
| 208 ========= |
| 209 |
| 210 If you find SCons helpful, please consider making a donation (of cash, |
| 211 software, or hardware) to support continued work on the project. |
| 212 Information is available at: |
| 213 |
| 214 http://www.scons.org/donate.html |
| 215 |
| 216 |
| 217 FOR MORE INFORMATION |
| 218 ==================== |
| 219 |
| 220 Check the SCons web site at: |
| 221 |
| 222 http://www.scons.org/ |
| 223 |
| 224 |
| 225 AUTHOR INFO |
| 226 =========== |
| 227 |
| 228 Steven Knight |
| 229 knight at baldmt dot com |
| 230 http://www.baldmt.com/~knight/ |
| 231 |
| 232 With plenty of help from the SCons Development team: |
| 233 Chad Austin |
| 234 Charles Crain |
| 235 Steve Leblanc |
| 236 Greg Noel |
| 237 Gary Oberbrunner |
| 238 Anthony Roach |
| 239 Greg Spencer |
| 240 Christoph Wiedemann |
| 241 |
| 242 Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The SCo
ns Foundation |
| 243 src/README.txt 5134 2010/08/16 23:02:40 bdeegan |
OLD | NEW |