FREEDM DGI REPOSITORY

Disclaimer

These source code files were created at as part of the FREEDM DGI Subthrust,
and are intended for use in teaching or research.  They may be freely copied,
modified and redistributed as long as modified versions are clearly marked as
such and this notice is not removed.

Neither the authors nor the FREEDM Project nor the National Science Foundation
make any warranty, express or implied, nor assumes any legal responsibility
for the accuracy, completeness or usefulness of these codes or any information
distributed with these codes.

Suggested modifications or questions about this code can be directed to 
Dr. Bruce McMillin, Department of Computer Science, Missouri University of
Science and Technology, Rolla, MO 65409 <ff@mst.edu>

Building This Project

1. Begin by installing Boost. You may be able to use your system's provided
Boost package, or you may need to begin by downloading Boost from 
http://www.boost.org/users/history/. The only supported version is Boost 1.46.1.

2. If you are using a Boost package, skip to step 4.

If you aren't using a package of boost, build it by extracting the source
tarball you downloaded to your home directory, navigating to it, and
invoking `sh bootstrap.sh` and then `bjam`. This will build Boost.

3. Next, define the BOOST_ROOT environment variable in your `.bashrc` by setting
it to the directory you built Boost in. 

For example: `export BOOST_ROOT='~/boost/'`

4. Navigate to the `Broker` directory within the source you cloned from GitHub
and invoke `cmake .` This will prepare all the makefiles.

5. Lastly, call `make` and wait for the FREEDM project to build.

6. Refer to the FREEDM Wiki at https://github.com/scj7t4/FREEDM/wiki for
information on configuration.