{"id":13726108,"url":"https://github.com/chrisnevers/mkocaml","last_synced_at":"2025-05-07T21:31:18.603Z","repository":{"id":51220635,"uuid":"231170447","full_name":"chrisnevers/mkocaml","owner":"chrisnevers","description":"🔨 Tool to generate OCaml projects","archived":false,"fork":false,"pushed_at":"2021-05-19T21:38:03.000Z","size":31,"stargazers_count":60,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-04T01:28:29.655Z","etag":null,"topics":["dune","git","ocaml","opam"],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrisnevers.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-01T03:14:44.000Z","updated_at":"2024-04-17T05:59:27.000Z","dependencies_parsed_at":"2022-09-23T05:13:29.078Z","dependency_job_id":null,"html_url":"https://github.com/chrisnevers/mkocaml","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisnevers%2Fmkocaml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisnevers%2Fmkocaml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisnevers%2Fmkocaml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisnevers%2Fmkocaml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisnevers","download_url":"https://codeload.github.com/chrisnevers/mkocaml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224654129,"owners_count":17347673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dune","git","ocaml","opam"],"created_at":"2024-08-03T01:02:52.801Z","updated_at":"2024-11-14T16:33:17.869Z","avatar_url":"https://github.com/chrisnevers.png","language":"OCaml","funding_links":[],"categories":["OCaml"],"sub_categories":[],"readme":"# 🐪 Mkocaml\n\nA simple helper I use to generate OCaml projects. I constantly find myself struggling to remember `dune` commands for\nvarious tasks and how to setup opam files. This project is intended to solve that and make setup quicker.\n\n\n\nThis tool generates:\n  * Git repository\n  * OCaml `.gitignore`\n  * Executable or Library with `inline-tests`\n  * Opam package\n  * Copy of the executable to `/usr/local/bin`\n  * Makefile with no nonsense commands\n  \n# Install\n      \n      opam install mkocaml\n\n\n# Examples\nCreating a new executable\n\n    \u003e mkocaml -e new\n    \u003e make\n    \u003e new\n    Hello, World!\nCreating a new library\n\n    \u003e mkocaml -l new\n    \u003e make\n   \n## Makefile\n    \n |Makefile command|Description|\n |---|---|\n |`make` or `make build` | Builds the project with dune, copies exe to `/usr/local/bin` |\n |`make install` | Installs the dune projects|\n |`make test` | Runs unit tests|\n |`make clean` | Cleans the project with dune|\n |`make doc` | Generates the documentation for the project|\n | `make publish` | Publishes the opam package| \n\n## Opam File\n\n`git config` is used to fill in details. \n\nThe project will be versioned at `1.0` by default. For subsequent releases, update the version in this file and `Makefile` (under the `publish` section).\n\nBefore publishing, ensure you fill in the `synopsis` section.\n\n# Contributions\nContributions to `mkocaml` are greatly appreciated! ❤️\n\nPlease try to keep its implementation unassuming and configurable. 🙂\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisnevers%2Fmkocaml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisnevers%2Fmkocaml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisnevers%2Fmkocaml/lists"}