sbp-2.2.7: README.md

# [SBP Bindings for Haskell][1]

Haskell client for Swift Binary Protocol (SBP).

## Requirements

`haskell-stack`: [Instructions here](https://github.com/commercialhaskell/stack/blob/master/doc/install_and_upgrade.md).

## Install from Hackage

Available on [Hackage as `sbp`](http://hackage.haskell.org/package/sbp).

The library supports building against Stackage LTS-5, LTS-6, and LTS-8. To
install from Hackage using `stack`:

    $ stack install --resolver lts-6.35 sbp # (LTS-6)

or

    $ stack install --resolver lts-8.21 sbp # (LTS-8)

or

    $ stack install --resolver lts-5.18 sbp # (LTS-5)

Note that we explicitly specify the resolvers to use, as installing `libsbp` may
fail to build with more recent resolvers.

Building with cabal is possible but not supported and may fail to build.

## Setup

To build:

    $ stack build

To install:

    $ stack install

To test and benchmark:

    $ stack test && stack bench

To deploy to Hackage:

    $ stack upload

## Usage Examples (TODO)

## References

# LICENSE

Copyright © 2015 Swift Navigation Inc.

[1]: https://github.com/swift-nav/libsbp/tree/master/haskell