##############################################################################
# FILE:        moos-ivp-anrp/README
# DATE:        AUG 04 2011
# DATE:        FEB 10 2013 (modified to reflect MOOS V10 build structure.
# DESCRIPTION: Contains important info regarding the moos-ivp-anrp tree.
##############################################################################

#=============================================================================
# Introduction
#=============================================================================
The moos-ivp-anrp repository contains modules developed by Andrew Patrikilakis

#=============================================================================
# Build Issues w.r.t. MOOS V10
#=============================================================================

MOOS V10 (packaged in MOOS-IvP 12.11Beta and 13.2) has a very different build
structure to prior releases.

This tree has been modified to reflect the MOOS V10 build structure.

#=============================================================================
# Directory Structure
#=============================================================================
The directory structure for the moos-ivp-anrp is decribed below:

bin                   - Directory for generated executable files
build                 - Directory for build object files
build.sh              - Script for building moos-ivp-anrp
build-clean.sh        - Script for building moos-ivp-anrp from scratch
CMakeLists.txt        - CMake configuration file for the project
data                  - Directory for storing data
docs                  - Directory for storing documents
lib                   - Directory for generated library files
README                - Contains helpful information - (this file).
src                   - Directory for source code


#=============================================================================
# Build Instructions
#=============================================================================

NOTE: This tree is dependent on MOOS and the MOOS-IvP tree being already 
checked out and built on your local machine. We recommend placing the 
"moos-ivp" and "moos-ivp-anrp" trees in the same directory. Otherwise you
will need to edit the moos-ivp-anrp/CMakeLists.txt file to properly reflect
the relative location of the two directories.

#--------------------
# Linux and Mac Users
#--------------------

To build on Linux and Apple platforms, execute the build script within this
directory:

   $ ./build.sh

Run "build.sh -h" for other cmd line options to the build script.

To build without using the supplied script, execute the following commands
within this directory:

   $ mkdir -p build
   $ cd build
   $ cmake ../
   $ make
   $ cd ..

#--------------
# Windows Users
#--------------
To build on Windows platform, open CMake using your favorite shortcut. Then 
set the source directory to be this directory and set the build directory
to the "build" directory inside this directory.

The source directory is typically next to the question:
   "Where is the source code?"

The build directory is typically next to the question:
   "Where to build the binaries?"

Alternatively, CMake can be invoked via the command line. However, you must
specify your gernerator. Use "cmake --help" for a list of generators and
additional help.

#=============================================================================
# Environment variables
#=============================================================================
The moos-ivp-anrp binaries files should be added to your path to allow them
to be launched from pAntler. 

##############################################################################
#                               END of README
##############################################################################