package mkocaml

  1. Overview
  2. Docs
Tool to generate OCaml projects

Install

Dune Dependency

github.com Readme BSD-3-Clause License Edit opam file Versions (2)

Authors

  1. C
    Chris Nevers <christophernevers96@gmail.com>

Maintainers

  1. C
    Chris Nevers <christophernevers96@gmail.com>

Sources

1.2.tar.gz
md5=21a4915e821d2c80ce84d2090439c94a
sha512=93234dab34f6b498f893b6f0267810ed0c752c238a6e4e6efbc75a6bf38d5ba6a996dae682a401eb0c236b5a974f5e23db9cf4464b06f09abf4d8df9c80d931b

Description

Published: 11 Jun 2021

README

🐪 Mkocaml

A simple helper I use to generate OCaml projects. I constantly find myself struggling to remember dune commands for various tasks and how to setup opam files. This project is intended to solve that and make setup quicker.

This tool generates:

  • Git repository

  • OCaml .gitignore

  • Executable or Library with inline-tests

  • Opam package

  • Copy of the executable to /usr/local/bin

  • Makefile with no nonsense commands

Install

  opam install mkocaml

Examples

Creating a new executable

> mkocaml -e new
> make
> new
Hello, World!

Creating a new library

> mkocaml -l new
> make

Makefile

Makefile command Description
make or make build Builds the project with dune, copies exe to /usr/local/bin
make install Installs the dune projects
make test Runs unit tests
make clean Cleans the project with dune
make doc Generates the documentation for the project
make publish Publishes the opam package

Opam File

git config is used to fill in details.

The project will be versioned at 1.0 by default. For subsequent releases, update the version in this file and Makefile (under the publish section).

Before publishing, ensure you fill in the synopsis section.

Contributions

Contributions to mkocaml are greatly appreciated! ❤️

Please try to keep its implementation unassuming and configurable. 🙂

Dependencies (3)

  1. base-unix
  2. dune >= "1.11.0"
  3. ocaml >= "4.04"

Dev Dependencies

None

Used by

None

Conflicts

None