--- ray/INSTALL.scons 2008/12/26 17:00:32 1.1 +++ ray/INSTALL.scons 2016/04/19 21:21:23 1.5 @@ -3,15 +3,16 @@ Building and Installing Radiance with SCons This file describes how to build and install Radiance using the SCons based build system (an alternative to the traditional makeall script -expleined in the README file). +explained in the README file). Requirements ------------ Please make sure that you have dowloaded and unpacked BOTH the Radiance -source package AND the archive with the auxiliary files. Crucial parts -of the system will be missing if you only have one of them. +source package AND the archive with the auxiliary support files. +Crucial parts of the system will be missing if you only have one of +them, and SCons will be unable to build the software. SCons is a platform-independent software configuration and build system written in Python. If SCons and Python are not already installed on your @@ -20,15 +21,25 @@ system, then you need to download and install them fir Python: http://www.python.org/ SCons: http://www.scons.org/ -For many systems, precompiled packages are availabls, such as Installer +For many systems, precompiled packages are available, such as Installer files for Windows. Most Linux distributions already come with Python installed and ready to use. -SCons *may* use a libtiff already installed on your system. However, if -it doesn't find one, it will build its own from sources included with -Radiance. +SCons *may* use a libtiff already installed on your system. On posix +systems it usually does. Otherwise the executables requiring it are +not built. +On Windows, Radiance gets built with MS Visual Studio if present, the +community editions are sufficient. +VS 2013 is currently the most recent version that does it correctly. +VS 2015 also performs the build, but it uses the new "universal CRT" +from Windows 10, which has a bug that corrupts data in text pipes. +A fix is apparently ready and should be released via autoupdate, +probably around the time of the "anniversary update" in summer 2016. +Older versions of VS may work as well, but haven't been tested with +the current sources. + Building -------- @@ -54,7 +65,7 @@ files for various build environments. In this context, specific combination of operating system and build tools (eg. compiler). On unix based systems, the compiler usually doesn't make much of a difference, but on Windows, there are seperate build environments for -toolkits like Cygwin or MingW. +toolkits like MingW. The file "ray/platform/README" explains the settings that can be configured in those files, and how to create a new one, if you use a @@ -88,6 +99,11 @@ SKIP=1|0 1: Skip display of License terms 0: Don't skip (default) +MSVC_VERSION=12.0|14.0 + "12.0" is the default for Visual Studio 2013. + Once the text pipe bug in the universal CRT is fixed, the default + will be changed to "14.0" for Visual Studio 2015. + SCons will remember the values given with those options. You don't need to supply them again each time when you run repeated builds and installs, but only when something changes. @@ -125,7 +141,7 @@ Installation ------------ The software will be installed into the directories given either in the -configuration file through command options, by invoking +configuration file or through command options, by invoking $> scons install @@ -147,7 +163,7 @@ Cleanup To save disk space on your system, or in preparation of a fresh build with different settings, you can clean up the source tree by invoking - %> scons -c + $> scons -c This will delete all the generated object files, libraries, and executables in and below the "ray/src/" subdirectory.