https://github.com/chrisnevers/mkocaml

🔨 Tool to generate OCaml projects
https://github.com/chrisnevers/mkocaml

dune git ocaml opam

Last synced: 3 months ago
JSON representation

🔨 Tool to generate OCaml projects

• Host: GitHub
• URL: https://github.com/chrisnevers/mkocaml
• Owner: chrisnevers
• License: bsd-3-clause
• Created: 2020-01-01T03:14:44.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-19T21:38:03.000Z (over 3 years ago)
• Last Synced: 2024-05-11T21:37:24.284Z (6 months ago)
• Topics: dune, git, ocaml, opam
• Language: OCaml
• Homepage:
• Size: 30.3 KB
• Stars: 60
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - mkocaml

README

        
# 🐪 Mkocaml

A simple helper I use to generate OCaml projects. I constantly find myself struggling to remember `dune` commands for

various tasks and how to setup opam files. This project is intended to solve that and make setup quicker.

This tool generates:

  * Git repository

  * OCaml `.gitignore`

  * Executable or Library with `inline-tests`

  * Opam package

  * Copy of the executable to `/usr/local/bin`

  * Makefile with no nonsense commands

  

# Install

      

      opam install mkocaml

# Examples

Creating a new executable

    > mkocaml -e new

    > make

    > new

    Hello, World!

Creating a new library

    > mkocaml -l new

    > make

   

## Makefile

    

 |Makefile command|Description|

 |---|---|

 |`make` or `make build` | Builds the project with dune, copies exe to `/usr/local/bin` |

 |`make install` | Installs the dune projects|

 |`make test` | Runs unit tests|

 |`make clean` | Cleans the project with dune|

 |`make doc` | Generates the documentation for the project|

 | `make publish` | Publishes the opam package| 

## Opam File

`git config` is used to fill in details. 

The project will be versioned at `1.0` by default. For subsequent releases, update the version in this file and `Makefile` (under the `publish` section).

Before publishing, ensure you fill in the `synopsis` section.

# Contributions

Contributions to `mkocaml` are greatly appreciated! ❤️

Please try to keep its implementation unassuming and configurable. 🙂