https://github.com/diskuv/dkml-runtime-apps

Common apps used in DKML
https://github.com/diskuv/dkml-runtime-apps

Last synced: 8 days ago
JSON representation

Common apps used in DKML

• Host: GitHub
• URL: https://github.com/diskuv/dkml-runtime-apps
• Owner: diskuv
• License: apache-2.0
• Created: 2022-05-05T18:06:33.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-12T08:57:29.000Z (2 months ago)
• Last Synced: 2024-09-13T11:07:21.144Z (2 months ago)
• Language: OCaml
• Size: 3.73 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-runtime-apps

This repository is meant for DkML contributors.

## Building

> You can do with following commands in Windows DkML

> preceding with `with-dkml bash`:

```sh

make switch

# Optional

make ide

# Only needed if you are changing Opam dependencies.

# Will not work on Windows until Opam Monorepo works on Windows

make duniverse

```

## Upgrading

```console

# Will not work on Windows until Opam Monorepo works on Windows

$ opam update

# Optional pins. If you need to test untagged dependencies.

$ opam pin dkml-runtime-common git+https://github.com/diskuv/dkml-runtime-common.git --no-action

$ opam pin dkml-runtime-distribution git+https://github.com/diskuv/dkml-runtime-distribution.git --no-action

$ touch with-dkml.opam

$ make duniverse

```

## Opam Monorepo

The `with-dkml` project and its dependency `dkml-runtimelib` have Opam Monorepo files:

* `with-dkml.opam.locked`

* `duniverse/`

The purpose of Opam Monorepo for `with-dkml` is so that `dune.2.9.3+shim.1.0.1` and the other Dune

shims can build `with-dkml.exe` _while_ building simultaneously building Dune. All we have to do is to check in

`duniverse/` and with a slight modification to Dune's `opam` file we can bundle `with-dkml.exe`

as a shim.

You can use:

* `opam install ./dkml-runtimelib.opam ./with-dkml.opam --locked` to install the Opam Monorepo version of `with-dkml`

* `opam install ./dkml-runtimelib.opam ./with-dkml.opam` to install the regular Opam version of `with-dkml`

* `make duniverse` to update the Dune universe `duniverse/`

You will need to do the following to **build** using the Dune universe without any Opam dependencies:

1. uncomment `(dirs :standard \ duniverse)` in the toplevel `dune` (or temporarily remove the toplevel `dune` file) and

2. run `dune build --display=short -p with-dkml,dkml-runtimelib`