diff options
| author | DJ O'Leary <dijitol@proton.me> | 2026-06-27 00:11:43 +0200 |
|---|---|---|
| committer | DJ O'Leary <dijitol@proton.me> | 2026-06-27 00:11:43 +0200 |
| commit | 976048a85403fbb0751c34fa42703a3c47f6e918 (patch) | |
| tree | 46e321d8120c45e318ead66f60165b0b854c85a1 /ocaml/README.md | |
| parent | 6d8fb621d1e93b83786890d6d9cb6f0d8defa8ae (diff) | |
refactor!: change repo directory structure for ocaml
Diffstat (limited to 'ocaml/README.md')
| -rw-r--r-- | ocaml/README.md | 55 |
1 files changed, 1 insertions, 54 deletions
diff --git a/ocaml/README.md b/ocaml/README.md index 772c76b..7d64eb8 100644 --- a/ocaml/README.md +++ b/ocaml/README.md @@ -1,54 +1 @@ -# 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 `advent_of_code` 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 -├── advent_of_code.install # autogenerated install script -└── advent_of_code.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) -- [re2](https://github.com/janestreet/re2) -- [fmt](https://erratique.ch/software/fmt) -- [cmdliner](https://erratique.ch/software/cmdliner) - -## License - -This project is licensed under the [Unlicense](https://unlicense.org/). +# Advent of Code: OCaml |
