ocaml-mem_usage
============

![GitHub](https://img.shields.io/github/license/savonet/ocaml-mem_usage)
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/savonet/ocaml-mem_usage/.github/workflows/main.yml?branch=main)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/savonet/ocaml-mem_usage)

ocaml-mem_usage is a simple cross-platform OCaml module to return information on memory usage.

Documentation:
=============

The [API documentation is available here](https://www.liquidsoap.info/ocaml-mem_usage/mem_usage/index.html)

Prerequisites:
==============

- ocaml
- dune
- findlib

See [dune-project](dune-project) file for versions.

Installation:
=============

The preferred installation method is via [opam](http://opam.ocaml.org/):

```
opam install mem_usage
```

This will install the latest release of `mem_usage`. If you wish to install the latest code from this repository, you can do:

```
opam install .
```

From within this repository.

Compilation:
============

```
dune build
```

Author:
=======

This author of this software may be contacted by electronic mail
at the following address: savonet-users@lists.sourceforge.net.
