Init project

.gitignore

+_build
+_opam
+.envrc
+.vscode

.ocamlformat

+profile = default
+margin = 80
+break-infix=fit-or-vertical

Makefile

+# usage: make [target]
+#
+# default target is help
+#
+# targets:
+
+default: help
+
+#   test: runs unit tests
+test:
+	opam exec dune test
+
+#   setup: installs a local switch as well as dependencies for the program
+setup: _opam deps dev-deps
+
+#   deps: install program dependencies
+deps: _opam
+	opam install --deps-only .
+
+dev-deps: _opam
+	opam install ocaml-lsp-server ocamlformat
+
+_opam:
+	opam switch create ./ ocaml-base-compiler.5.2.0
+
+#   build: recompiles the application
+build: _opam
+	opam exec dune build
+
+#   help: shows the possible targets
+help:
+	@sed -ne 's/^#\(.*\)$$/\1/p' Makefile
+
+.PHONY: default setup deps dev-deps help test build

bin/dune

+(executable
+ (public_name ocaml_edt)
+ (name main)
+ (libraries ocaml_edt cmdliner))

bin/main.ml

+(*
+Copyright 2024 Emmanuel Coquery
+
+This file is part of OCamlEDT.
+
+OCamlEDT is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+OCamlEDT is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+OCamlEDT. If not, see <https://www.gnu.org/licenses/>.
+
+*)
+open Cmdliner
+
+let run () = print_endline "Hello, World!"
+let run_t = Term.(const run $ const ())
+let cmd = Cmd.v (Cmd.info "ocaml_edt") run_t
+let () = exit (Cmd.eval cmd)

doc/license-header.txt

+Copyright 2024 Emmanuel Coquery
+
+This file is part of OCamlEDT.
+
+OCamlEDT is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+OCamlEDT is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+OCamlEDT. If not, see <https://www.gnu.org/licenses/>.

dune-project

+(lang dune 3.16)
+
+(name ocaml_edt)
+
+(generate_opam_files true)
+
+(source
+ (github ecoquery/ocaml_edt))
+
+(authors "Emmanuel Coquery")
+
+(maintainers "Emmanuel Coquery")
+
+(license "GPL-3.0-or-later")
+
+(documentation https://url/to/documentation)
+
+(package
+ (name ocaml_edt)
+ (synopsis "Generates timetables for course planification")
+ (description "Program and library to generate a timetable for a course or a set of courses, outputs in HTML format among others")
+ (depends ocaml dune cmdliner)
+ (tags
+  (topics "timetable")))
+
+; See the complete stanza docs at https://dune.readthedocs.io/en/stable/reference/dune-project/index.html

lib/dune

+(library
+ (name ocaml_edt))

ocaml_edt.opam

+# This file is generated by dune, edit dune-project instead
+opam-version: "2.0"
+synopsis: "Generates timetables for course planification"
+description:
+  "Program and library to generate a timetable for a course or a set of courses, outputs in HTML format among others"
+maintainer: ["Emmanuel Coquery"]
+authors: ["Emmanuel Coquery"]
+license: "GPL-3.0-or-later"
+tags: ["topics" "timetable"]
+homepage: "https://github.com/ecoquery/ocaml_edt"
+doc: "https://url/to/documentation"
+bug-reports: "https://github.com/ecoquery/ocaml_edt/issues"
+depends: [
+  "ocaml"
+  "dune" {>= "3.16"}
+  "cmdliner"
+  "odoc" {with-doc}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+]
+dev-repo: "git+https://github.com/ecoquery/ocaml_edt.git"

test/dune

+(test
+ (name test_ocaml_edt))

test/test_ocaml_edt.ml

+(*
+Copyright 2024 Emmanuel Coquery
+
+This file is part of OCamlEDT.
+
+OCamlEDT is free software: you can redistribute it and/or modify it under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+OCamlEDT is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+OCamlEDT. If not, see <https://www.gnu.org/licenses/>.
+
+*)
\ No newline at end of file