Illinois Rocstar Project Template documentation group

Illinois Rocstar Project Template

IRProject Basics

Introduction

This is the main documentation page for IRProject.

IRProject is a template project that can be used as an example for documentation, and/or testing, or as a template for creating a software suite that can be readily integrated into Illinois Rocstar's software development environment with unified look, feel, and style.

IRProject includes:

• Base CMake files
• Base CTest files
• Example/Model Documentation
• Example Unit Tests
• Example serial andd parallel programs
• Uses/depends on IRAD

Build and Install IRProject

IRProject uses the CMake build system. CMake is a system for configuration and building that generates platform indpendent build files (e.g. Makefiles) for software packages.

Get IRProject

Get IRProject from the IR repository:

svn co ${IRREPO}/IRProject/trunk IRProject

Set Up Your Build Environment

Create a directory in which to build IRProject:

mkdir build_irproject
cd build_irproject

Tell CMake where you want to install IRProject:

CMAKE_INSTALL_PREFIX=/the/path/to/IRProject/Installation

If you have third party software tools installed in non-standard locations then you need to let CMake know where to find those packages:

CMAKE_PREFIX_PATH=/third_party_install/path1:/third_party_install/path2

Makefile Generation

Invoke cmake to generate your makefiles:

cmake ../IRProject

Build and Install IRProject

Build and test the IRProject with:

make
make test

Guides

• How To Make A New IR Project
• Use IR Project Template in an Existing Project
• How To Set Up Testing for an IR Project
• IR Documentation Guide
• IR Coding Guide