package dkml-install

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

Install

Dune Dependency

Authors

Maintainers

Sources

v0.1.0.tar.gz
md5=9c2fc122d49103ce9bf513fcc11b443d
sha512=c746d7a4482109c725bfe44542c146914add4d77e8e76556ce0de6e2567683a7ac7dc9909f1252aea7facbcf130153b8e752607a3c44e35b8cfd8ea5d99eb356

Description

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

Published: 06 Jul 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 (2)

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

Used by (2)

  1. dkml-install-installer < "0.2.0"
  2. dkml-install-runner < "0.2.0"

Conflicts

None