https://github.com/diskuv/dkml-install-api

API for OCaml installation plugins
https://github.com/diskuv/dkml-install-api

Last synced: 8 days ago
JSON representation

API for OCaml installation plugins

• Host: GitHub
• URL: https://github.com/diskuv/dkml-install-api
• Owner: diskuv
• License: apache-2.0
• Created: 2022-01-17T05:23:48.000Z (almost 3 years ago)
• Default Branch: 0.5
• Last Pushed: 2024-09-15T01:39:13.000Z (2 months ago)
• Last Synced: 2024-09-16T01:08:41.503Z (2 months ago)
• Language: OCaml
• Homepage: https://diskuv.github.io/dkml-install-api/index.html
• Size: 5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DkML Install API 0.5.3

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.

> ¹ *Well-known* is an aspiration. Currently only a simple CLI installer

> generator is available, but other well-known installer generators like

> 0install or cpack could be added in the future.

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 

The OCaml module documentation is available at 

## Installing

Make sure you have Opam installed and then run:

```bash

opam install dkml-install-api

```

## Building from Source

On Windows with Diskuv OCaml:

```powershell

dkml init

with-dkml opam install . --with-test --with-doc

with-dkml dune build

with-dkml dune build `@doc

```

On Unix:

```bash

opam install .--with-test --with-doc

dune build

dune build @doc

```

## Contributing

See [the Contributors section](contributors/README.md).