binaryen-0.0.1.1: README.md

# Haskell bindings for [binaryen][binaryen]

[![Build status](https://badge.buildkite.com/f96af58baa5635b8cdef87abddc9070765fa4f562cc6cb8f47.svg?branch=master)](https://buildkite.com/tweag-1/haskell-binaryen)

[Binaryen][binaryen] is a compiler and toolchain infrastructure
library for WebAssembly, written in C++. This package defines
bindings to the [Binaryen API][binaryen-api].

[binaryen]: https://github.com/WebAssembly/binaryen
[binaryen-api]: https://github.com/WebAssembly/binaryen/blob/master/src/binaryen-c.h

## Versioning

Binaryen evolves fast and can introduce C API changes in every release. Before
building the Haskell bindings, please check the Binaryen version and make sure
it's no less than the minimum version listed below.

| Haskell bindings version | Minimum Binaryen version |
|--------------------------|--------------------------|
| 0.0.1.*                  | version_91               |


## How to build

This package relies on the system-provided Binaryen library. As long as that's
available, a simple `stack build` or `cabal build` command should work.

`Nix`-based build is also supported. Install [Stack][stack] and [Nix][nix].
Then,

```shell
$ stack --nix build
```

[nix]: https://nixos.org/nix/
[stack]: https://docs.haskellstack.org/en/stable/README/