INSTALL.txt

//===----------------------------------------------------------------------===//
// LFort Installation Instructions
//===----------------------------------------------------------------------===//

These instructions describe how to build and install LFort.

//===----------------------------------------------------------------------===//
// Step 1: Organization
//===----------------------------------------------------------------------===//

LFort is designed to be built as part of an LLVM build. Assuming that the LLVM
source code is located at $LLVM_SRC_ROOT, then the lfort source code should be
installed as:

  $LLVM_SRC_ROOT/tools/lfort

The directory is not required to be called lfort, but doing so will allow the
LLVM build system to automatically recognize it and build it along with LLVM.

//===----------------------------------------------------------------------===//
// Step 2: Configure and Build LLVM
//===----------------------------------------------------------------------===//

Configure and build your copy of LLVM (see $LLVM_SRC_ROOT/GettingStarted.html
for more information).

Assuming you installed lfort at $LLVM_SRC_ROOT/tools/lfort then LFort will
automatically be built with LLVM. Otherwise, run 'make' in the LFort source
directory to build LFort.

//===----------------------------------------------------------------------===//
// Step 3: (Optional) Verify Your Build
//===----------------------------------------------------------------------===//

It is a good idea to run the LFort tests to make sure your build works
correctly. From inside the LFort build directory, run 'make test' to run the
tests.

//===----------------------------------------------------------------------===//
// Step 4: Install LFort
//===----------------------------------------------------------------------===//

From inside the LFort build directory, run 'make install' to install the LFort
compiler and header files into the prefix directory selected when LLVM was
configured.

The LFort compiler is available as 'lfort' and supports a gcc like command line
interface. See the man page for lfort (installed into $prefix/share/man/man1)
for more information.