README

# HCLIB Overview

HCLIB is a library version of the Habanero-C language.

# Getting Started

## Installation

HCLIB currently supports two runtime backends

    - Open Community Runtime (OCR)
    - Custom RunTime (crt)

See the `INSTALL.*` files for detailed installation instructions.

## Running HCLIB non-regression tests

    cd tests;
    ./runTests

# Writing programs using HCLIB

HCLIB defines a C-based interface in the `hclib.h` header file.
Just use the include directive in your program to import the interface:

    #include "hclib.h"

# Linking with HCLIB

If you have set the `HCLIB_ROOT` and `OCR_INSTALL` environment variable as
described in the `INSTALL` file, you can define the following environment
variables to simplify compiler command line simpler:

	export HCLIB_CFLAGS="-I${HCLIB_ROOT}/include"
	export HCLIB_LDFLAGS="-L${HCLIB_ROOT}/lib -lhclib"

Linking against HCLIB is then done easily:

    gcc -g ${HCLIB_LDFLAGS} ${HCLIB_CFLAGS} your_program.c