README.developer

################################################################################
# Copyright (c) 2012 Los Alamos National Security, LLC
# All rights reserved.
################################################################################

If you are interested in using the repository files for development, you will
need to configure the project build system using the GNU Autotools.  Several
utilities exist to facilitate development.  A full description is beyond the
scope of this README file.

#------------------------------------------------------------------------------#
# Build System
#------------------------------------------------------------------------------#

To build the autotools buildsystem run:

% config/bootstrap

#------------------------------------------------------------------------------#
# Machine files
#------------------------------------------------------------------------------#

This project supports the selection of most configuration options through
a 'machine' file that lists a set of AC_DEFINE-defined environment variables,
which will override any options passed to the 'configure' script.  A set
of templates are provided in the top-level directory of this project under
the 'machine' sub-directory.  To use a machine file, copy a template into
the 'machine' directory, edit the parameters and then run 'configure' with:

% ./configure --with-machine=your_machine_file_name

#------------------------------------------------------------------------------#
# Distribution
#------------------------------------------------------------------------------#

To create a distribution, run the following in a directory that has been
configured using the 'configure' script:

% make dist

#------------------------------------------------------------------------------#
# Out-of-source builds
#------------------------------------------------------------------------------#

This project supports out-of-source builds, e.g., the following set of
commands will configure the project for an out-of-source build:

% cd your_project_directory
% mkdir build
% cd build
% ../configure --with-machine=machine_file_name ...