package dkml-install

  1. Overview
  2. Docs
API and registry for Diskuv OCaml (DKML) installation components

Install

Dune Dependency

Authors

Maintainers

Sources

v0.2.0.tar.gz
md5=d65935d6a9a790fec09cfc50f6b04c43
sha512=08aeffeffa41b10ca54c9329bf9f6ec9219060c2e62c3a389d08b096513fe3dc048782e28d5006cae6a35e124cfd09441eb41a063c6a3f12fc6e60fa9d2acef7

Description

All DKML installation components implement the interfaces exposed in this API.

Published: 09 Aug 2022

README

DKML Install API 0.1.0

The DKML Install API lets you take the tools you know (OCaml and Opam) and well-known¹ installer generators, to generate a installer for your OCaml project.

Specifically the DKML Install API lets you take a) pre-designed packages from Opam and b) installation instructions written in OCaml source code, and assembles binary artifacts that act as the primary materials to installer generators.

The full documentation is available at https://diskuv.github.io/dkml-install-api/index.html

The OCaml module documentation is available at https://diskuv.github.io/dkml-install-api/odoc/index.html

Installing

Make sure you have Opam installed and then run:

opam install dkml-install-api

Building from Source

On Windows with Diskuv OCaml:

with-dkml opam dkml init
with-dkml opam install . --with-test --with-doc --deps-only
with-dkml dune build
with-dkml dune build `@doc

On Unix:

opam install .--with-test --with-doc --deps-only
dune build
dune build @doc

Contributing

See the Contributors section.

Dependencies (9)

  1. tsort >= "2.1.0"
  2. fmt >= "0.8.9"
  3. cmdliner >= "1.0.4"
  4. bos >= "0.2.0"
  5. astring >= "0.8.5"
  6. result >= "1.5"
  7. ppx_deriving >= "5.2.1"
  8. dune >= "2.9"
  9. ocaml >= "4.08.0"

Dev Dependencies (3)

  1. diskuvbox >= "0.1.0" & with-test
  2. odoc >= "1.5.3" & with-doc
  3. alcotest >= "1.4.0" & with-test

Conflicts

None