summaryrefslogtreecommitdiff
path: root/src/README.txt
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2003-02-07 07:05:09 +0000
committerSteven Knight <knight@baldmt.com>2003-02-07 07:05:09 +0000
commit1e93334baa5bafe099bba0bbb2878cfbc4349ac1 (patch)
tree73f0208106d249b4b5e5164e42e951f5157ffefc /src/README.txt
parent4f6a2c926304ee3ea444b6854991489702252c0e (diff)
downloadscons-1e93334baa5bafe099bba0bbb2878cfbc4349ac1.tar.gz
Fix case-sensitive packaging problem on Win32.
Diffstat (limited to 'src/README.txt')
-rw-r--r--src/README.txt55
1 files changed, 43 insertions, 12 deletions
diff --git a/src/README.txt b/src/README.txt
index ca73a556..e9c6455e 100644
--- a/src/README.txt
+++ b/src/README.txt
@@ -87,23 +87,54 @@ provided Python-standard setup script as follows:
# python setup.py install
-This will install the scons script in the default system script
-directory (/usr/bin or C:\Python*\Scripts, for example) and the build
-engine in an appropriate SCons library directory (/usr/lib/scons or
-C:\Python*\SCons, for example).
+If this is the first time you are installing SCons on your system,
+the above command will install the scons script in the default system
+script directory (/usr/bin or C:\Python*\Scripts, for example) and the
+build engine in an appropriate stand-alone SCons library directory
+(/usr/lib/scons or C:\Python*\scons, for example).
-You should have system installation privileges (that is, "root" or
-"Administrator") when running the setup.py script to install SCons in
-the default system directories.
+Note that, by default, SCons does not install its library in the
+standard Python library directories. If you want to be able to use the
+SCons library modules (the build engine) in other Python scripts, you
+can run the setup script as follows:
-If you don't have system installation privileges, you can use the
---prefix option to specify an alternate installation location, such as
-your home directory:
+ # python setup.py install --standard-lib
+
+This will install the build engine in the standard Python
+library directory (/usr/lib/python*/site-packages or
+C:\Python*\Lib\site-packages).
+
+Alternatively, you may want to install multiple versions of SCons
+side-by-side, which you can do as follows:
+
+ # python setup.py install --version-lib
+
+This will install the build engine in a version-specific library
+directory (/usr/lib/scons-__VERSION__ or C:\Python*\scons-__VERSION__).
+
+If this is not the first time you are installing SCons on your system,
+the setup script will, by default, search for where you have previously
+installed the SCons library, and install this version's library the
+same way--that is, if you previously installed the SCons library in
+the standard Python library, the setup script will install this one
+in the same location. You may, of course, specify one of the --*-lib
+options described above to select a specific library location, or use
+the following option to explicitly select installation into the default
+standalone library directory (/usr/lib/scons or C:\Python*\scons):
+
+ # python setup.py install --standalone-lib
+
+Note that, to install SCons in any of the above system directories,
+you should have system installation privileges (that is, "root" or
+"Administrator") when running the setup.py script. If you don't have
+system installation privileges, you can use the --prefix option to
+specify an alternate installation location, such as your home directory:
$ python setup.py install --prefix=$HOME
-This will install the scons script itself in $HOME/bin and the
-associated library in $HOME/lib/scons
+This will install SCons in the appropriate locations relative to
+$HOME--that is, the scons script itself $HOME/bin and the associated
+library in $HOME/lib/scons, for example.
DOCUMENTATION