Diskuv OCaml Starter

Diskuv OCaml is an OCaml distribution focused on a) secure, cross-platform software development and b) ease of use for language learners and professional developers.

Documentation is available at https://diskuv.gitlab.io/diskuv-ocaml/

Installation

Windows: https://diskuv.gitlab.io/diskuv-ocaml/

macOS:

! command -v opam && brew install gpatch && brew install opam pkg-config cmake ninja
./makeit build-dev

Packages installed:

• gpatch is needed for brew's opam package
• CMake and Ninja are requirements of vcpkg
• pkg-config is required for many OCaml packages

Licensing

The subdirectories named diskuv-ocaml, in particular vendor/diskuv-ocaml/, have the diskuv-ocaml Fair Source license. diskuv-ocaml is the core package for the Diskuv OCaml distribution, is free for personal use, and can have limited commercial use for up to 5 developers; it also has broad exceptions for OCaml package maintainers. Fair Source licenses are neither open-source nor closed-source and are described in more detail at https://fair.io/.

School teachers and college professors may redistribute the Diskuv OCaml distribution to their students under the diskuv-ocaml LICENSE; each student is covered for free personal use.

The remainder of diskuv-ocaml-starter is open-source and licensed liberally under the Apache v2.0 LICENSE.txt.

License questions can be directed to [email protected].

Continuous Testing

GitLab

The authoritative starter source code is on GitLab at https://gitlab.com/diskuv/diskuv-ocaml-starter. Currently there are no GitLab CI scripts.

GitHub

There is a mirror of the starter source code on GitHub at https://github.com/diskuv/diskuv-ocaml-starter-ghmirror.

The directory .github/workflows has a set of GitHub Actions you can use to build and test your own Local Projects. You can see the results at https://github.com/diskuv/diskuv-ocaml-starter-ghmirror/actions