README.BUILD

README.BUILD
-------------------------------------------------
Contents:

I.	Overview
II.	Build Requirements
III.	Tested Platforms
IV.	Build Time Options

-------------------------------------------------

I.	Overview
-------------------------------------------------

The HMC-Sim build environment is designed to
build a simple (static) library for
executing HMC device simulations for
one or more homogeneous devices.


II.	Build Requirements
-------------------------------------------------

- GNU Make
- C Compiler (GCC is default)


III.	Tested Platforms
-------------------------------------------------

- Mac OSX/Darwin 10.9.5 + gcc 4.2.1
- Mac OSX/Darwin 10.9.5 + clang 2.9 (OSX)
- Ubuntu 14.04LTS + gcc 4.8.4
- Ubuntu 14.04LTS + clang 3.3


IV.	Build Time Options
-------------------------------------------------

Building HMC-Sim can be completed by simply
typing "make".  If additional modifications
to the build environment need to be made,
modify the Makfile.inc script.

For additional Makefile.inc variants, see
the 'configs' directory.

-------------------------------------------------
EOF