INSTALL

                  Compiling and Installing SML#

== Requirements

The following softwares are required to build and install SML#:

  * C/C++ compiler: GNU Compiler Collection or Clang.
  * GNU make or BSD make
  * GNU MP library
  * LLVM 3.4

== Quick Start

  $ ./configure
  $ make
  $ make install

Things will be installed under /usr/local/bin and /usr/local/lib/smlsharp.

== Configurations

If you meet some troubles caused by C compiler, rerun configure
to try to compile with another compiler.

  $ ./configure CC=<C_COMPILER> CXX=<C++_COMPILER>

If some required libraries are installed in non-standard directory on your
system, you need to specify CPPFLAGS and LDFLAGS so that compiler can
find them. For example:

  $ ./configure CPPFLAGS=-I/opt/pkg/include LDFLAGS=-L/opt/pkg/lib

You will see all build-time configurations by invoking configure with
--help option.

== Customizing install location

Run configure with --prefix option to specify where to install.

  $ ./configure --prefix=<PREFIX>

If the --prefix option is omitted, /usr/local is assumed as PREFIX.
Things are installed in those locations:

  <PREFIX>/bin/smlsharp          SML# compiler
  <PREFIX>/bin/smlformat         SMLFormat
  <PREFIX>/bin/smllex            SML# variant of ML-lex
  <PREFIX>/bin/smlyacc           SML# variant of ML-yacc
  <PREFIX>/lib/smlsharp/         Directory for libraries of SML#