https://github.com/OCamlPro/drom

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.
https://github.com/OCamlPro/drom

Last synced: about 2 months ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/OCamlPro/drom
• Owner: OCamlPro
• License: other
• Created: 2020-08-27T08:57:36.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-07T13:55:25.000Z (11 months ago)
• Last Synced: 2024-05-19T06:03:37.264Z (4 months ago)
• Language: OCaml
• Homepage: https://ocamlpro.github.io/drom
• Size: 12.5 MB
• Stars: 178
• Watchers: 17
• Forks: 21
• Open Issues: 46
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-list - drom - 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. | OCamlPro | 118 | (OCaml)

README

        

[![Actions Status](https://github.com/ocamlpro/drom/workflows/Main%20Workflow/badge.svg)](https://github.com/ocamlpro/drom/actions)

[![Release](https://img.shields.io/github/release/ocamlpro/drom.svg)](https://github.com/ocamlpro/drom/releases)

# 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.

* Website: https://ocamlpro.github.io/drom

* General Documentation: https://ocamlpro.github.io/drom/sphinx

* API Documentation: https://ocamlpro.github.io/drom/doc

* Sources: https://github.com/ocamlpro/drom

## 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.