Added INSTALL with basic instructions for building with SCons

This commit is contained in:
Ray Speth 2012-07-03 17:49:59 +00:00
parent f04ac23be9
commit d3c93c5339

22
INSTALL Normal file
View file

@ -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.