From d3c93c5339e322a7e0a74fcaca3d86a52f54730d Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Tue, 3 Jul 2012 17:49:59 +0000 Subject: [PATCH] Added INSTALL with basic instructions for building with SCons --- INSTALL | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 INSTALL diff --git a/INSTALL b/INSTALL new file mode 100644 index 000000000..b2e9b4ff6 --- /dev/null +++ b/INSTALL @@ -0,0 +1,22 @@ +Installing Cantera +****************** + +Basic Instructions +------------------ + +To compile using the default options, run `scons build` followed by +`scons install`. + +Configuration options are specified with `name=value` on the command line, e.g.: +`scons build optimize=n prefix=/home/$USER/cantera` + +The full list of configuration options and their default values can be shown by +running `scons help`. The list of available scons commands (e.g. `build`) can be +shown by running `scons` with no other arguments. + + +Detailed Instructions +--------------------- + +See the file `doc/sphinx/compiling.rst` or the HTML instructions +available at http://cantera.github.com/docs/sphinx/html/compiling.html.