Skip to content

Commit

Permalink
chore!: Mention implicit python dependency in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Jan 12, 2022
1 parent 6b4f71f commit 6e8aa0e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -42,6 +42,12 @@ This project aims to provide full feature parity with the [Binaryen C API](https

None of these are particularly challenging to create bindings for—they just haven't been written yet. If you need anything that's missing, feel free to open a PR.

## Python dependency

When using this package with `esy`, you'll need to ensure that a `python` executable exists in one of these locations: `/usr/local/bin/python`, `/usr/bin/python`, `/bin/python`, `/usr/sbin/python`, or `/sbin/python`. Esy will only look for python in those locations, and it is not provided for you in the sandbox.

**Note:** This implicit dependency will be removed in a future version.

## MacOS C++ Compiler

When including this library in your `dune` MacOS executables, you'll need to specify `-cc clang++` in your `(ocamlopt_flags)` stanza. This is required because Binaryen will throw errors for itself to catch and using `clang++` is the only way to handle them correctly. You can find more info on this [ocaml issue](https://github.com/ocaml/ocaml/issues/10423).
Expand Down

0 comments on commit 6e8aa0e

Please sign in to comment.