Skip to content

Commit

Permalink
Update docs and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
mooreryan committed Mar 23, 2022
1 parent 4d1ee8b commit e01dcf3
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

NA

## 0.3.1 (2022-03-23)

### Changed

- Reduce number of dependencies (including when installing from the GitHub repository).
- Use `re` instead of `re2` for regular expressions.
- Drop some of the dev dependencies from the `opam` file.

## 0.3.0 (2022-03-18)

### Added
Expand Down
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,29 @@ For information on installing and using `pyml_bindgen`, check out the [docs](htt

Additionally, you can find examples in the [examples](https://github.com/mooreryan/ocaml_python_bindgen/tree/main/examples) directory. One neat thing about these examples is that you can see how to write Dune [rules](https://dune.readthedocs.io/en/stable/dune-files.html#rule) to automatically generate your `pyml` bindings.

## Development
## Installing from sources

If you want to install from sources, e.g., to track the main branch or a development branch, but you do not want to install all the test and development packages, clone the repository, checkout the branch you want to follow and run opam install manually:

If you want to work on `pyml_bindgen` development, you may want to install a couple of additional packages that are not specified in the `opam` file.
```
$ git clone https://github.com/mooreryan/ocaml_python_bindgen.git
$ git checkout dev
$ opam install .
```

This will save a lot of install time as it avoids some heavy packages.

## Development

- To run the benchmarks, you will need `core` and `core_bench`.
- To run test instrumentation, you will need `bisect_ppx`.
If instead, you want to work on `pyml_bindgen` development, will need to ensure you have the test dependencies, as well as a couple dependencies that are not included in the `opam` file (`core`, `core_bench`, and `bisect_ppx`.)

E.g.,

```
$ git clone https://github.com/mooreryan/ocaml_python_bindgen.git
$ opam install . --deps-only --with-doc --with-test
$ opam install core core_bench bisect_ppx
$ dune build
```

## License
Expand Down

0 comments on commit e01dcf3

Please sign in to comment.