diff options
Diffstat (limited to '2025/ocaml/README.md')
| -rw-r--r-- | 2025/ocaml/README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/2025/ocaml/README.md b/2025/ocaml/README.md new file mode 100644 index 0000000..2500c9e --- /dev/null +++ b/2025/ocaml/README.md @@ -0,0 +1,54 @@ +# OCaml Template + +This is a template for OCaml projects. + +## Quick Start + +1. Fork this repository +2. Rename the repository to your project name +3. Replace all instances of `ocaml_template` with your project name, both in files and filenames themselves. + +## Project Structure + +```txt +. +├── _build # build outputs +├── bin # program entry points +├── docs # documentation +├── lib # public modules +├── test # tests +├── .editorconfig +├── .envrc +├── .gitignore +├── .ocamlformat # ocamlformat configuration +├── CODEOWNERS +├── CONTRIBUTING.md +├── LICENSE +├── README.md +├── Taskfile.yml # task runner configuration similar to make +├── dune-project # dune project configuration +├── flake.lock +├── flake.nix # nix flake configuration +├── ocaml_template.install # autogenerated install script +└── ocaml_template.opam # autogenerated project description +``` + +## Tools + +- [task](https://taskfile.dev/) +- [dune](https://dune.build/) +- [opam](https://opam.ocaml.org/) +- [ocamlformat](https://ocaml.org/p/ocamlformat/latest/doc/index.html) +- [odoc](https://ocaml.github.io/odoc/odoc/index.html) +- [alchotest](https://github.com/mirage/alcotest) +- [bisect_ppx](https://github.com/aantron/bisect_ppx) +- [ocaml-lsp](https://github.com/ocaml/ocaml-lsp) +- [earlybird](https://github.com/ocaml-lsp/earlybird) +- [findlib](https://github.com/ocaml/ocamlfind) +- [menhir](https://github.com/ocaml-menhir/menhir) +- [re2](https://github.com/janestreet/re2) +- [fmt](https://erratique.ch/software/fmt) + +## License + +This project is licensed under the [Unlicense](https://unlicense.org/). |
