mxthevs/ocaml-starter

OCaml starter template. With esy and dune.

ocaml-starter

Opinionated OCaml starter template. With esy and dune.

Dune by default assumes that all the source code lays on the same directory as the dune file. If you want to have subdirs inside lib then you have to have a separated dune file for each of them. But this template comes with (include_subdirs unqualified) as a dune option. Which allows having others subdirs inside lib without having to setup them as separated libraries. If you do not want this behaviour just remove this line.

Prerequisites

esy

A package manager for the OCaml ecosystem. It can install packages from opam and from npm.

It also automatically resolves transitive dependencies, and generates a lock file containing their versions to make it easier to replicate your setup on multiple machines without storing the downloaded dependencies.

npm i -g esy

Or, if you're using yarn

yarn global add esy

Up and running

Install the dependencies with esy:

esy

Build the project:

esy build

Run the example binary:

esy x ocaml_starter <dividend> <divisor>

ocaml-starter's Issues

Remove ocamlformat

Having a formatter is nice, but this project uses a lot of now deprecated ocamlformat options, and, personally, I'm not too fond of the default options. Maybe we can remove ocamlformat and leave it up to the user to have a formatter.