Skip to content
/ drom Public

drom is a wrapper over opam/dune in an attempt to provide a cargo-like user experience. It can be used to create full OCaml projects with sphinx and odoc documentation. It has specific knowledge of Github and will generate files for Github Actions CI and Github pages.

License

Notifications You must be signed in to change notification settings

OCamlPro/drom

Folders and files

NameName
Last commit message
Last commit date
Jun 5, 2024
Apr 24, 2023
Jun 5, 2024
Mar 10, 2023
Jun 5, 2024
Jun 27, 2024
Dec 31, 2022
Jun 5, 2024
Nov 24, 2021
Dec 31, 2022
Mar 10, 2023
Sep 6, 2020
May 10, 2023
Oct 5, 2020
Jun 5, 2024
Jun 5, 2024
Mar 10, 2023
Dec 21, 2020
Jun 5, 2024
Mar 10, 2023
Jun 5, 2024

Repository files navigation

Actions Status Release

drom

The drom tool is a wrapper over opam/dune in an attempt to provide a cargo-like user experience. It can be used to create full OCaml projects with sphinx and odoc documentation. It has specific knowledge of Github and will generate files for Github Actions CI and Github pages.

Simple Example

You can create a new OCaml project with:

$ drom new my-client --skeleton mini_prg
Creating project "my-client" with skeleton "mini_prg", license "LGPL2"
  and sources in src/my-client:
Creating directory my-client
Using skeleton "program" for package "my-client"
[master (root-commit) 8d83262] Initial commit

└── my-client/
    ├── .drom             (drom state, do not edit)
    ├── .github/
    │   └── workflows/
    │       └── workflow.yml
    ├── .gitignore
    ├── CHANGES.md
    ├── LICENSE.md
    ├── Makefile
    ├── README.md
    ├── drom.toml    <────────── project config EDIT !
    ├── dune
    ├── dune-project
    ├── opam/
    │   └── my-client.opam
    ├── scripts/
    │   ├── after.sh
    │   ├── before.sh
    │   └── copy-bin.sh
    └── src/
        └── my-client/
            ├── dune
            ├── main.ml
            ├── package.toml    <────────── package config EDIT !
            └── version.mlt

This project uses the minimalist mini_prg skeleton, but other skeletons like program or library have more files.

About

drom is a wrapper over opam/dune in an attempt to provide a cargo-like user experience. It can be used to create full OCaml projects with sphinx and odoc documentation. It has specific knowledge of Github and will generate files for Github Actions CI and Github pages.

Resources

License

Stars

Watchers

Forks

Packages

No packages published