src/README.txt

   1 # Copyright (c) 2001, 2002 Steven Knight
   2 # __FILE__ __REVISION__ __DATE__ __DEVELOPER__
   3
   4
   5                  SCons - a software construction tool
   6
   7                          Version __VERSION__
   8
   9
  10 This is an alpha release of SCons, a tool for building software (and
  11 other files).  SCons is implemented in Python, and its "configuration
  12 files" are actually Python scripts, allowing you to use the full power
  13 of a real scripting language to solve build problems.  You do not,
  14 however, need to know Python to use SCons effectively.
  15
  16 See the RELEASE.txt file for notes about this specific release,
  17 including known problems.  See the CHANGES.txt file for a list of
  18 changes since the previous release.
  19
  20
  21 LATEST VERSION
  22 ==============
  23
  24 Before going further, you can check that this package you have is
  25 the latest version by checking the SCons download page at:
  26
  27         http://www.scons.org/download.html
  28
  29
  30 REQUIREMENTS
  31 ============
  32
  33 SCons requires Python version 1.5.2 or later.  There should be no
  34 other dependencies or requirements to run SCons.
  35
  36 The default SCons configuration assumes use of the Microsoft Visual C++
  37 compiler suite on WIN32 systems, and assumes a C compiler named 'cc'
  38 and a C++ compiler named 'c++' (such as found in the GNU C compiler
  39 suite) on any other type of system.  You may, of course, override these
  40 default values by appropriate configuration of Environment construction
  41 variables.
  42
  43
  44 INSTALLATION
  45 ============
  46
  47 To install this package, simply run the provided Python-standard setup
  48 script as follows:
  49
  50         # python setup.py install
  51
  52 This will install the scons script in the default system script
  53 directory (/usr/bin or C:\Python*\Scripts, for example) and the build
  54 engine in an appropriate SCons library directory (/usr/lib/scons or
  55 C:\Python*\SCons, for example).
  56
  57 You should have system installation privileges (that is, "root" or
  58 "Administrator") when running the setup.py script to install SCons in
  59 the default system directories.
  60
  61 If you don't have system installation privileges, you can use the
  62 --prefix option to specify an alternate installation location, such as
  63 your home directory:
  64
  65         $ python setup.py install --prefix=$HOME
  66
  67 This will install the scons script itself in $HOME/bin and the
  68 associated library in $HOME/lib/scons
  69
  70
  71 DOCUMENTATION
  72 =============
  73
  74 See the RELEASE.txt file for notes about this specific release,
  75 including known problems.  See the CHANGES.txt file for a list of
  76 changes since the previous release.
  77
  78 The scons.1 man page is included in this package, and contains a section
  79 of small examples for getting started using SCons.
  80
  81 Additional documentation for SCons is available at:
  82
  83         http://www.scons.org/doc.html
  84
  85
  86 LICENSING
  87 =========
  88
  89 SCons is distributed under the MIT license, a full copy of which is
  90 available in the LICENSE.txt file. The MIT license is an approved Open
  91 Source license, which means:
  92
  93         This software is OSI Certified Open Source Software.  OSI
  94         Certified is a certification mark of the Open Source Initiative.
  95
  96 More information about OSI certifications and Open Source software is
  97 available at:
  98
  99         http://www.opensource.org/
 100
 101
 102 REPORTING BUGS
 103 ==============
 104
 105 You can report bugs either by following the "Tracker - Bugs" link
 106 on the SCons project page:
 107
 108         http://sourceforge.net/projects/scons/
 109
 110 or by sending mail to the SCons developers mailing list:
 111
 112         scons-devel@lists.sourceforge.net
 113
 114
 115 MAILING LISTS
 116 =============
 117
 118 A mailing list for users of SCons is available.  You may send
 119 questions or comments to the list at:
 120
 121         scons-users@lists.sourceforge.net
 122
 123 You may subscribe to the mailing list at:
 124
 125         http://lists.sourceforge.net/lists/listinfo/scons-users
 126
 127 There is also a low-volume mailing list available for announcements
 128 about SCons.  Subscribe at:
 129
 130         http://lists.sourceforge.net/lists/listinfo/scons-announce
 131
 132
 133 FOR MORE INFORMATION
 134 ====================
 135
 136 Check the SCons web site at:
 137
 138         http://www.scons.org/
 139
 140
 141 AUTHOR INFO
 142 ===========
 143
 144 Steven Knight
 145 knight at baldmt dot com
 146 http://www.baldmt.com/~knight/
 147
 148 With plenty of help from the SCons Development team:
 149         Chad Austin
 150         Charles Crain
 151         Steve Leblanc
 152         Anthony Roach
 153