Skip to content
This repository was archived by the owner on Nov 13, 2024. It is now read-only.

Commit 014e0a7

Browse files
committed
Various corrections before the initial Hackage release
1 parent 6e782a0 commit 014e0a7

File tree

6 files changed

+36
-14
lines changed

6 files changed

+36
-14
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
# CHANGELOG for `binaryen`
2+
3+
## 0.0.1.0
4+
5+
- Initial release.

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
11
# Haskell bindings for [binaryen][binaryen]
22

3-
[Binaryen][binaryen] is a compiler and toolchain infrastructure
4-
library for WebAssembly, written in C++. This package defines
5-
bindings to the [Binaryen API][binaryen-api].
3+
[Binaryen][binaryen] is a compiler and toolchain infrastructure library for
4+
WebAssembly, written in C++. This package defines complete bindings to the
5+
[Binaryen C API][binaryen-api], and can be useful to building WebAssembly
6+
toolchains in Haskell.
67

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

11+
## Versioning
12+
13+
Binaryen evolves fast and can introduce C API changes in every release. Before
14+
building the Haskell bindings, please check the Binaryen version and make sure
15+
it's no less than the minimum version listed below.
16+
17+
| Haskell bindings version | Minimum Binaryen version |
18+
|--------------------------|--------------------------|
19+
| 0.0.1.0 | version_91 |
20+
21+
1022
## How to build
1123

12-
Install [Stack][stack] and [Nix][nix]. Then,
24+
This package relies on the system-provided Binaryen library. As long as that's
25+
available, a simple `stack build` or `cabal build` command should work.
26+
27+
`Nix`-based build is also supported. Install [Stack][stack] and [Nix][nix].
28+
Then,
1329

1430
```shell
1531
$ stack --nix build

binaryen.cabal

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ cabal-version: 1.12
44
--
55
-- see: https://github.com/sol/hpack
66
--
7-
-- hash: 40cc0a5eb6ca4a5799291a6d00ba13156956f3eaee86026aadc94fb81d6cb63f
7+
-- hash: 03e2312883b6c64eed02f51b849ace2fd17c7d87de0c4e12cfbd2f53482ea034
88

99
name: binaryen
10-
version: 0.0.1
10+
version: 0.0.1.0
11+
synopsis: Haskell bindings to binaryen
12+
description: Haskell bindings to [binaryen](https://github.com/WebAssembly/binaryen). Provides complete bindings to the C API, which can be useful for building WebAssembly toolchains in Haskell.
1113
category: Compiler
12-
stability: alpha
1314
homepage: https://github.com/tweag/asterius#readme
1415
bug-reports: https://github.com/tweag/asterius/issues
1516
maintainer: Shao Cheng <cheng.shao@tweag.io>

package.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
name: binaryen
2-
version: 0.0.1
2+
version: 0.0.1.0
3+
synopsis: Haskell bindings to binaryen
4+
description: Haskell bindings to [binaryen](https://github.com/WebAssembly/binaryen). Provides complete bindings to the C API, which can be useful for building WebAssembly toolchains in Haskell.
35
category: Compiler
4-
stability: alpha
56
maintainer: Shao Cheng <cheng.shao@tweag.io>
67
copyright: (c) 2018 Tweag I/O
78
license: BSD3

stack.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
resolver: lts-15.7
1+
resolver: lts-15.9
22

33
nix:
44
path: [nixpkgs=./nixpkgs.nix]

stack.yaml.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
packages: []
77
snapshots:
88
- completed:
9-
size: 491389
10-
url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/15/7.yaml
11-
sha256: 92ab6303fe20ec928461c82ce0980b4d17c06f4e66205a2967e476474f686c17
12-
original: lts-15.7
9+
size: 492027
10+
url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/15/9.yaml
11+
sha256: 11394dc975e96c2fea90f7f2b3229630d46351a092ebcec78f0a56403930b429
12+
original: lts-15.9

0 commit comments

Comments
 (0)